simono41/snappass
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add debug server steps to development flow

Browse source
This commit is contained in:
Samuel Dion-Girardeau 2016-08-22 20:13:10 -04:00
parent a8401434cb
commit ae9bebb365
1 changed files with 14 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
CONTRIBUTING.rst
View file

@ -85,25 +85,35 @@ Here's how to set up `snappass` for local development.
Now you can make your changes locally. Now you can make your changes locally.
5. When you're done making changes, check that your changes pass the tests and 5. You can test your changes in a development server with debug and autoreload::
$ docker run -d --name redis-server -p 6379:6379 redis
$ export FLASK_DEBUG=1 && \
export FLASK_APP=snappass.main && \
export NO_SSL=True
$ flask run
You now have a running instance on localhost:5000/
6. When you're done making changes, check that your changes pass the tests and
flake8:: flake8::
$ flake8 snappass tests $ flake8 snappass tests
$ tox $ tox
6. Commit your changes and push your branch to GitHub:: 7. Commit your changes and push your branch to GitHub::
$ git add . $ git add .
$ git commit -m "Your detailed description of your changes." $ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature $ git push origin name-of-your-bugfix-or-feature
7. Check that the test coverage hasn't dropped:: 8. Check that the test coverage hasn't dropped::
coverage run --source snappass setup.py tests coverage run --source snappass setup.py tests
coverage report -m coverage report -m
coverage html coverage html
8. Submit a pull request through the GitHub website. 9. Submit a pull request through the GitHub website.
Pull Request Guidelines Pull Request Guidelines
----------------------- -----------------------