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

CONTRIBUTING: make clear that --accept works for all golden tests...

Browse source 
not just docx.
This commit is contained in:
John MacFarlane 2019-07-19 09:29:10 -07:00
parent d4b2128d55
commit 72ddbf5994
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
CONTRIBUTING.md
View file

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