From f96e13477685df24f65388b08c83f2bf960c1970 Mon Sep 17 00:00:00 2001 From: Florian B Date: Wed, 16 Oct 2019 12:44:30 +0200 Subject: [PATCH] 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. --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4b8214a0ea55..23c5c7ba43c1 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