fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-07-05 16:06:14 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update contributing to include pytest-bdd changes

Browse source
This commit is contained in:
Micah Jerome Ellison 2021-07-10 12:53:52 -07:00
parent 0d4b4832f2
commit bed68fd077
1 changed files with 2 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/contributing.md
View file

@ -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