diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md index c7d67e8..9fa6de9 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,20 @@ Options: -h, --help show this help message and exit ``` +## Hacking + +Unit testing is done with [Hypothesis] and [pytest]. Since scadere +does not depend on any Python package, testing can be safely done in-tree: + + PYTHONPATH=src pytest + ## Contributing +Please make sure that patches maintain the full branch [coverage]: + + PYTHONPATH=src coverage run + coverage report + Patches should be sent to [chung@loa.loang.net][loang mailing list] using [`git send-email`][git send-email], with the following configuration: @@ -53,6 +65,9 @@ under the terms of the GNU [Affero General Public License][agplv3] as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +[Hypothesis]: https://hypothesis.rtfd.io +[pytest]: https://docs.pytest.org +[coverage]: https://coverage.rtfd.io [loang mailing list]: https://loa.loang.net/chung [git send-email]: https://git-send-email.io [agplv3]: https://www.gnu.org/licenses/agpl-3.0.html |