From bed68fd0772a7bd053142c96e7fd13a4053ea0ac Mon Sep 17 00:00:00 2001 From: Micah Jerome Ellison Date: Sat, 10 Jul 2021 12:53:52 -0700 Subject: [PATCH] Update contributing to include pytest-bdd changes --- docs/contributing.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index c846010f..bf3c393c 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -96,11 +96,9 @@ A typical development workflow includes: When resolving bugs or adding new functionality, please add tests to prevent that functionality from breaking in the future. If you notice any functionality that isn't covered in the tests, feel free to submit a test-only pull request as well. -For integration testing, jrnl uses [behave](https://behave.readthedocs.io/) tests, which are all in the `features` folder. +jrnl uses [pytest](https://docs.pytest.org/) for unit tests. It also uses pytest to run behavior-driven development (BDD) tests via [pytest-bdd](https://pytest-bdd.readthedocs.io/en/stable/). -Many tests can be created by only editing `feature` files with the same format as other tests. For more complicated functionality, you may need to implement steps in `features/steps` which are then executed by your tests in the `feature` files. - -Starting in 2020, jrnl is also using [pytest](https://docs.pytest.org/) for unit tests. These tests are in the `tests` folder. +BDD tests can be created by editing `.feature` files in `tests/bdd/features` with the same format as other tests. For more complicated functionality, you may need to implement steps in `tests/lib` which are then executed by your tests in the `.feature` files. ### Submitting pull requests