Contributing to Python Projects We welcome contributions to Python Projects! Here are some guidelines to help you get started.
Filing a bug report If you find a bug in the project, please file a bug report by creating a new issue in the GitHub repository. Be sure to include the following information:
A clear and descriptive title A description of the problem, including any error messages or tracebacks Steps to reproduce the problem If applicable, the version of the project and any relevant dependencies If applicable, a code sample that reproduces the problem Requesting a feature If you have a feature request, please file a feature request by creating a new issue in the GitHub repository. Be sure to include the following information:
A clear and descriptive title A description of the problem or use case the feature would solve If applicable, any relevant information about current workarounds or solutions If applicable, any relevant information about similar features in other projects Submitting a pull request If you're ready to contribute code to the project, please follow these steps:
Fork the repository and create your branch from master. Make sure your code follows the project's style guidelines. Make sure your code is well-documented and has appropriate test coverage. Run the tests to ensure they pass. Submit a pull request to the master branch of the original repository. The repository maintainers will review your code and may request changes before merging. Code of Conduct We expect all contributors to the project to abide by our Code of Conduct.
Additional resources GitHub documentation on contributing Python documentation on style Python documentation on testing