Trusted97/fast-api-boilerplate

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
# 🚀 Contributing Guidelines

Welcome to the contributing guidelines for the FastAPI Boilerplate project! Contributions are highly appreciated. Feel free to submit issues and pull requests. 🎉

## 🔀 Commit Format

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`
    

## 🛑 Steps to Contribute

1.  Fork the repository on GitHub.
2.  Clone the forked repository to your local machine:

            `git clone https://github.com/YourUsername/fast-api-boilerplate.git`
            `cd fast-api-boilerplate`
        

4.  Create a new branch for your feature or bug fix:

            `git checkout -b feature/new-feature`
        

6.  Make your changes and commit them using conventional commits.

            `git commit -m "feat: add new feature"`
        

8.  Push your changes to your forked repository on GitHub:

            `git push origin feature/new-feature`
        

10.  Create a pull request on the original repository.

## 🐳 Local Development with Docker

For local development, Docker is available to set up the development environment effortlessly. 🐳

        `docker-compose up --build -d`
    

## 📝 License

This project is licensed under the MIT License.