aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian B <yuuki@protonmail.com>2019-10-16 12:44:30 +0200
committerJohn MacFarlane <jgm@berkeley.edu>2019-10-16 09:09:08 -0700
commitc55651d761e761f8a9b7dcdaef2b0c75740cd256 (patch)
treeaea40655af03930f97f76d144cf675b4603ba768
parenta933ad30fb0ae7309f8ac14616337cfc95cdb7cd (diff)
downloadpandoc-c55651d761e761f8a9b7dcdaef2b0c75740cd256.tar.gz
Add info about command test naming to CONTRIBUTING
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.
-rw-r--r--CONTRIBUTING.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4b8214a0e..23c5c7ba4 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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
are changing. Alternatively, you may add a "command test" to
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
`--accept` to the test script. (If you're using stack, `stack