Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Add info about command test naming to CONTRIBUTING

Browse source 
Added a paragraph about naming conventions for tests in `test/command/`
to the contributors guide. Advises to include issue number and/or
feature being tested.
This commit is contained in:
Florian B 2019-10-16 12:44:30 +02:00 • committed by John MacFarlane
parent a933ad30fb
commit c55651d761
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CONTRIBUTING.md
View file

@ -187,6 +187,9 @@ modify `test/Tests/Old.hs`. Otherwise, it is better to modify the module
under the `test/Tests` hierarchy corresponding to the pandoc module you under the `test/Tests` hierarchy corresponding to the pandoc module you
are changing. Alternatively, you may add a "command test" to are changing. Alternatively, you may add a "command test" to
the `/test/command/` hierarchy, following the pattern of the tests there. the `/test/command/` hierarchy, following the pattern of the tests there.
These test files should have a meaningful name, which can include the issue
number and/or the feature that's being tested. For example, `5474-tables.md`
refers to both issue and feature.
You can rebuild the golden tests in `tests/` by passing You can rebuild the golden tests in `tests/` by passing
`--accept` to the test script. (If you're using stack, `stack `--accept` to the test script. (If you're using stack, `stack