aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAlbert Krewinkel <albert@zeitkraut.de>2021-03-16 16:34:38 +0100
committerGitHub <noreply@github.com>2021-03-16 08:34:38 -0700
commit84b7a153758b1495c66b793a251bf83618abb415 (patch)
tree0fd288f438c7e91c7bb1a037e7019219a4d7d963 /CONTRIBUTING.md
parentff0fcedcb3c33015f9d550acce8fad2d662d49bd (diff)
downloadpandoc-84b7a153758b1495c66b793a251bf83618abb415.tar.gz
CONTRIBUTING: suggest using a `cabal.project.local` file (#7153)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 595fb94ff..090cc0a4f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -244,9 +244,16 @@ Or with stack:
stack test --test-arguments='-p markdown'
-It is often helpful to add `-j4` (run tests in parallel)
-and `--hide-successes` (don't clutter output with successes)
-to the test arguments as well.
+It is often helpful to add `-j4` (run tests in parallel) and
+`--hide-successes` (don't clutter output with successes) to the test
+arguments as well. Collecting all options in a `cabal.project.local`
+file in the project's root directory can help to keep `cabal`
+commands short. E.g.:
+
+ flags: +embed_data_files
+ tests: True
+ test-show-details: direct
+ test-options: -j4 --hide-successes
If you add a new feature to pandoc, please add tests as well, following
the pattern of the existing tests. The test suite code is in