From 545b41b944a4b5cc7c693b80ea4dbbdac4d008ea Mon Sep 17 00:00:00 2001 From: Baptiste Jonglez Date: Fri, 24 Apr 2020 18:46:20 +0200 Subject: [PATCH] Add brief documentation about updating and adding tests --- docs/contributing.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 8e0cfb8a..34015241 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -126,10 +126,19 @@ Running tests Please, think about updating and running the tests before asking for a pull request as it will help us to maintain the code clean and running. -To do so:: +To run the tests:: make test +Tests can be edited in ``ihatemoney/tests/tests.py``. If some test cases fail because +of your changes, first check whether your code correctly handle these cases. +If you are confident that your code is correct and that the test cases simply need +to be updated to match your changes, update the test cases and send them as part of +your pull request. + +If you are introducing a new feature, you need to either add tests to existing classes, +or add a new class (if your new feature is significantly different from existing code). + Formatting code ---------------