ARMmaster17/watergrid-python

View on GitHub
.github/CONTRIBUTING.md

Summary

Maintainability
Test Coverage
Headers should be surrounded by blank lines
# Contributing
## Issues
Line length
Please follow the issue submission template when submitting issues. The more detailed you are,
the faster your issue will be addressed.
 
Line length
If you need help with implementing Watergrid in your project, and you do not feel you have encountered
a bug, please open a thread on GitHub Discussions instead.
 
Headers should be surrounded by blank lines
## Pull Requests
Line length
Please follow the pull request submission template when submitting pull requests. The more detailed
you are, the faster your pull requests will be reviewed.
 
Line length
Note that there are several required checks that must pass before your pull request can be approved.
Line length
All pull requests are tested against all non-EoL stable Python versions. Additionally, the Watergrid
Line length
project uses the `black` tool to format code. It is recommended that you run this tool locally before
Line length
committing to reduce GitHub Actions usage. Code Climate also analyzes test coverage, and your pull
Line length
request may be rejected if it does not test at least half of all new code, or reduces the overall project
coverage by 1% or more.