summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2018-02-03 09:21:21 -0500
committerAndrew Gallant <jamslam@gmail.com>2018-02-03 09:21:21 -0500
commitcb0e693e310919306fceaa42c1b259f9b3dc4990 (patch)
treec590fc8c4a2e01a32bcc63e7fbfc93141b3073a1
parente9d448e93bb4e1fb3b0c1afc29adb5af6ed5283d (diff)
docs: touch up issue template
-rw-r--r--ISSUE_TEMPLATE.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
index 010b84f1..bf9abe9b 100644
--- a/ISSUE_TEMPLATE.md
+++ b/ISSUE_TEMPLATE.md
@@ -23,10 +23,24 @@ If possible, please include both your search patterns and the corpus on which
you are searching. Unless the bug is very obvious, then it is unlikely that it
will be fixed if the ripgrep maintainers cannot reproduce it.
+If the corpus is too big and you cannot decrease its size, file the bug anyway
+and the ripgrep maintainers will help figure out next steps.
+
#### If this is a bug, what is the actual behavior?
-Show the command you ran and the actual output. Include the `--debug` in your
-invocation of ripgrep if possible.
+Show the command you ran and the actual output. Include the `--debug` flag in
+your invocation of ripgrep.
+
+If the output is large, put it in a gist: https://gist.github.com/
+
+If the output is small, put it in code fences:
+
+```
+your
+output
+goes
+here
+```
#### If this is a bug, what is the expected behavior?