Thank you for considering contributing to the FastAPI Kickstart template project! We welcome contributions from the community to improve and enhance the project. To ensure a smooth contribution process, please follow the guidelines outlined below.
If you encounter any bugs or issues with the project, please follow these steps to report them:
- Search for Existing Issues: Before creating a new issue, check the issue tracker to see if the issue has already been reported.
- Provide Details: When reporting a new issue, provide as much detail as possible. Include the following information:
- A clear and descriptive title
- Steps to reproduce the issue
- Expected and actual behavior
- Screenshots or logs, if applicable
If you have a suggestion for a new feature or improvement, please follow these steps:
- Search for Existing Requests: Check the issue tracker to see if the feature request has already been submitted.
- Provide a Detailed Description: Include a detailed description of the feature or improvement, including its use case and potential benefits.
To contribute code changes, please follow these guidelines:
- Fork the Repository: Fork the repository to your own GitHub account.
- Clone Your Fork: Clone the forked repository to your local machine.
- Create a New Branch: Create a new branch for your changes:
git checkout -b your-feature-branch
- Make Changes: Make your changes in the new branch. Be sure to write clear, concise commit messages.
- Run tests: Make sure all tests pass before submitting your changes.
- Submit a Pull Request: Push your changes to your fork and submit a pull request to the main repository.
If you have any questions or need further assistance, feel free to reach out by opening an issue or contacting the project maintainers.
Thank you for contributing!