diff options
| author | John MacFarlane <jgm@berkeley.edu> | 2019-07-19 09:29:10 -0700 |
|---|---|---|
| committer | John MacFarlane <jgm@berkeley.edu> | 2019-07-19 09:29:10 -0700 |
| commit | 72ddbf5994a09ca45b57e1260f71a081e4d085a5 (patch) | |
| tree | d1fb561c77c9b9d02ac13f1571dbc3023fb6999c /CONTRIBUTING.md | |
| parent | d4b2128d55f558069fb9ba88bb6cae534da98151 (diff) | |
| download | pandoc-72ddbf5994a09ca45b57e1260f71a081e4d085a5.tar.gz | |
CONTRIBUTING: make clear that `--accept` works for all golden tests...
not just docx.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b2cf63c3b..4cb355d03 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -188,12 +188,14 @@ 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. -For `docx` tests, you can rebuild the golden tests by passing `--accept` -to the test script (so if you're using stack, -`stack test --test-arguments "-p Docx --accept"`. Then just make sure to -commit the changed golden files in their own commit with a line that you -checked them in Word (mentioning Word version and OS), that they weren't -corrupted, and that they had the expected output. +You can rebuild the golden tests in `tests/` by passing +`--accept` to the test script. (If you're using stack, `stack +test --test-arguments "--accept"`; or `make TESTARGS=--accept`). +Then check the changed golden files for accuracy, and +commit the changes. For docx or pptx tests, open the files in Word +or Powerpoint to ensure that they weren't corrupted and that +they had the expected result, and mention the Word/Powerpoint +version and OS in your commit comment. Benchmarks ---------- |