Vasanko/sanic
2
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Merge pull request #725 from 38elements/contributing

Browse Source 
Add rule in CONTRIBUTING.md
This commit is contained in:
Eli Uriegas 2017-05-15 14:45:57 -07:00 committed by GitHub
commit 826c2e0f4e
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
CONTRIBUTING.md
View File

@ -29,14 +29,19 @@ See it's that simple!
## Pull requests! ## Pull requests!
So the pull request approval rules are pretty simple: So the pull request approval rules are pretty simple:
1. All pull requests must pass unit tests 1. All pull requests must pass unit tests.
2. All pull requests must be reviewed and approved by at least 2. All pull requests must be reviewed and approved by at least
one current collaborator on the project one current collaborator on the project.
3. All pull requests must pass flake8 checks 3. All pull requests must pass flake8 checks.
4. If you decide to remove/change anything from any common interface 4. All pull requests must be consistent with the existing code.
5. If you decide to remove/change anything from any common interface
a deprecation message should accompany it. a deprecation message should accompany it.
5. If you implement a new feature you should have at least one unit 6. If you implement a new feature you should have at least one unit
test to accompany it. test to accompany it.
7. An example must be one of the following:
* Example of how to use Sanic
* Example of how to use Sanic extensions
* Example of how to use Sanic and asynchronous library
## Documentation ## Documentation