summaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2020-04-14 16:23:47 -0400
committerAndrew Gallant <jamslam@gmail.com>2020-04-14 16:23:47 -0400
commit3f1d4b397df30362a88d759fadf8ae2e613d1339 (patch)
tree72a63f016a33d877a22e372d229d208450c8eaec /.github
parenta75b4d122a479bedf01b571c42c864e199e57ed2 (diff)
github: switch to new issue template format
And also point folks toward Discussions.
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md46
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml6
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md8
3 files changed, 60 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..fc68281b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,46 @@
+#### What version of ripgrep are you using?
+
+Replace this text with the output of `rg --version`.
+
+#### How did you install ripgrep?
+
+If you installed ripgrep with snap and are getting strange file permission or
+file not found errors, then please do not file a bug. Instead, use one of the
+Github binary releases.
+
+#### What operating system are you using ripgrep on?
+
+Replace this text with your operating system and version.
+
+#### Describe your bug.
+
+Give a high level description of the bug.
+
+#### What are the steps to reproduce the behavior?
+
+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.
+
+#### What is the actual behavior?
+
+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
+```
+
+#### What is the expected behavior?
+
+What do you think ripgrep should have done?
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000..edc82065
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,6 @@
+blank_issues_enabled: true
+contact_links:
+ - name: Ask a question
+ about: |
+ You've come to seek help or want to discuss something related to ripgrep.
+ url: https://github.com/BurntSushi/ripgrep/discussions/new
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..e2514c9c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,8 @@
+#### Describe your feature request
+
+Please describe the behavior you want and the motivation. Please also provide
+examples of how ripgrep would be used if your feature request were added.
+
+If you're not sure what to write here, then try imagining what the ideal
+documentation of your new feature would look like in ripgrep's man page. Then
+try to write it.