Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1.72 KB
Raw

Firstly, thank you for taking time and contributing to the project. All your efforts to contribute are highly appreciated!

Feature Requests

Feature Requests by the community are highly encouraged. Clearly state why this feature is necessary or why it will be a great addition to the project along with sample use cases to help developers better understand it.

Reporting an issue

Before submitting an issue please make sure:

  • You have already searched for related issues, and found none open (if you found a related closed issue, please link to it from your post).
  • You have referred to FastAPI's documentation for solutions.
  • Your issue title is concise, on-topic and polite.
  • You can and do provide steps to reproduce your issue.
  • For developers, please make sure your environment is setup correctly.

Workflow for submitting a PR

  1. Fork the repository to your own GitHub account

  2. Clone from your repository

    $ git clone https://github.com/your-username/repository-name
  1. Create a virtual environment (always a good practice!) and install the development dependencies
    $ pip install -r requirements.txt

  1. Make the necessary changes

  2. Run the tests

    $ pytest -vs
  1. Create a new pull request with an appropriate title, detailed explanation of what the pull request does and attach links to other issues or pull requests related to your pull request

License

By contributing your code to the FastAPI Starter Template GitHub repository, you agree to license your contribution under the Apache License 2.0.