Welcome to the contributing guidelines for the FastAPI Boilerplate project! Contributions are highly appreciated. Feel free to submit issues and pull requests. 🎉
Make sure that your commits follow the conventional commit format. Use appropriate emojis to categorize your changes. 📦
Example of a conventional commit:
`feat: add new feature`
-
Fork the repository on GitHub.
-
Clone the forked repository to your local machine:
`git clone https://github.com/YourUsername/fast-api-boilerplate.git` `cd fast-api-boilerplate`
-
Create a new branch for your feature or bug fix:
`git checkout -b feature/new-feature`
-
Make your changes and commit them using conventional commits.
`git commit -m "feat: add new feature"`
-
Push your changes to your forked repository on GitHub:
`git push origin feature/new-feature`
-
Create a pull request on the original repository.
For local development, Docker is available to set up the development environment effortlessly. 🐳
`docker-compose up --build -d`
This project is licensed under the MIT License.