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

Updated to reflect review changes

Browse Source
This commit is contained in:
Akshay B N 2016-12-27 15:16:01 +05:30 committed by GitHub
parent 13e27e53f0
commit 9270911045
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/contributing.md
View File

@ -23,7 +23,11 @@ Get the source of sanic:
Install sanic : Install sanic :
`python setup.py install` `python setup.py install develop`
OR
`pip install -e .`
Install the dev dependencies: Install the dev dependencies:
@ -37,11 +41,11 @@ Now you can start working on sanic.
## Tests ## Tests
Install pytest and flake8: Install pytest and flake8 or tox:
`pip install pytest` `pip install pytest`
`pip install flake8` `pip install flake8` or `pip install tox`
Run the tests: Run the tests:
@ -56,4 +60,4 @@ Run the tests:
Once all tests have passed send out a PR. Once all tests have passed send out a PR.
## Warning ## Warning
One of the main goals of Sanic is speed. Code that lowers the performance of Sanic without significant gains in usability, security, or features may not be merged. One of the main goals of Sanic is speed. Sanic uses `wrk` tool for benchmarking purposes. Code that lowers the performance of Sanic without significant gains in usability, security, or features may not be merged.