Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 1.85 KB

CONTRIBUTING.rst

File metadata and controls

65 lines (45 loc) · 1.85 KB
Raw

Contributing

Please file bugs to the Github issue tracker. Pull requests are welcome.

Hacking and Pull Requests

Please try to conform to PEP8 for code contributions and ensure that the tests continue to function.

Please include new tests with your pull requests when appropriate.

Feel free to open pull requests before you've finished your code or tests. Opening your pull request sooner will allow others to comment on it sooner.

A checklist of things to remember when making a feature:

  • Write tests if applicable
  • Note important changes in the CHANGES file
  • Update the README file if needed
  • Update the documentation if needed
  • Add yourself to the AUTHORS file

Running the tests

You will need tox and coverage installed to run the tests on your code:

$ pip install tox coverage

To run the tests and generate a coverage report:

$ ./runtests.sh

The coverage output should look similar to this:

_____________________ summary _____________________
py27: commands succeeded
py32: commands succeeded
py33: commands succeeded
pypy: commands succeeded
flake8: commands succeeded
congratulations :)
Name             Stmts   Miss Branch BrMiss  Cover
--------------------------------------------------
names/__init__      25      0      8      0   100%
names/main           4      0      0      0   100%
--------------------------------------------------
TOTAL               29      0      8      0   100%