Skip to content

Commit

Permalink
Improve README.rst with more info on development
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandrebarbaruiva committed Jan 23, 2021
1 parent 1f972f1 commit 91f81f6
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,13 +140,21 @@ Development

Pull requests should take care of updating the changelog ``HISTORY.txt``.

Under the unreleased section, add your changes and your username.

Manual testing
++++++++++++++

To test your changes, make use of ``manual_test.py``. Create a virtual environment,
install IPython and run ``python manual_test.py`` and check if your changes are in effect.
If possible, create automated tests for better behaviour control.

Automated testing
+++++++++++++++++

To run automated tests locally, create a virtual environment, install `coverage`
and run `coverage run setup.py test`.

Third-party support
-------------------

Expand Down

0 comments on commit 91f81f6

Please sign in to comment.