git.iko.soy/typeable/pandoc
on master help sign in
CONTRIBUTING: make clear that `--accept` works for all golden tests...

not just docx.

commit72ddbf5994a09ca45b57e1260f71a081e4d085a5 authorJohn MacFarlane <jgm@berkeley.edu> dateFri 19 Jul 2019, 09:29 (7 years ago) parentd4b2128
1 file changed+8−6
CONTRIBUTING.md+8−6
CONTRIBUTING.md+8−6
@@ -188,12 +188,14 @@ under the `test/Tests` hierarchy corresponding to the pandoc module you
188188are changing. Alternatively, you may add a "command test" to
189189the `/test/command/` hierarchy, following the pattern of the tests there.
190190
191−For `docx` tests, you can rebuild the golden tests by passing `--accept`
192−to the test script (so if you're using stack,
193−`stack test --test-arguments "-p Docx --accept"`. Then just make sure to
194−commit the changed golden files in their own commit with a line that you
195−checked them in Word (mentioning Word version and OS), that they weren't
196−corrupted, and that they had the expected output.
191+You can rebuild the golden tests in `tests/` by passing
192+`--accept` to the test script. (If you're using stack, `stack
193+test --test-arguments "--accept"`; or `make TESTARGS=--accept`).
194+Then check the changed golden files for accuracy, and
195+commit the changes. For docx or pptx tests, open the files in Word
196+or Powerpoint to ensure that they weren't corrupted and that
197+they had the expected result, and mention the Word/Powerpoint
198+version and OS in your commit comment.
197199
198200Benchmarks
199201----------