Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

41 lines (29 loc) · 1.22 KB
Raw

Contributing

Any contributions of docs or tests or code would be awesome.

Here's how:

  1. Fork it
  2. Clone your fork (git clone https://my_fork)
  3. Create a branch (git checkout -b my_branch)
  4. Commit your changes (git commit -am "added some cool feature")
  5. Push your branch to your fork (git push origin my_branch)
  6. Open a Pull Request
  7. Respond to any questions during our review process

Read more about how pulls work on GitHub's About pull requests page.

Running the Tests

Before even thinking about sending us a pull request, you must first write some tests (and eat some dogfood by using assertpy assertions in any tests you write).

Our favorite python test runner is pytest. To run all the tests, just execute py.test in the base project folder (above the tests/ folder) like this:

PYTHONPATH=. py.test -v tests

Should produce output something like this:

===== test session starts =====
collected 589 items

tests/test_bool.py::test_is_true PASSED
..
tests/test_warn.py::test_failures PASSED

===== 589 passed in 1.91s =====