From 3f1d4b397df30362a88d759fadf8ae2e613d1339 Mon Sep 17 00:00:00 2001 From: Andrew Gallant Date: Tue, 14 Apr 2020 16:23:47 -0400 Subject: [PATCH] github: switch to new issue template format And also point folks toward Discussions. --- .../ISSUE_TEMPLATE/bug_report.md | 17 +++++------------ .github/ISSUE_TEMPLATE/config.yml | 6 ++++++ .github/ISSUE_TEMPLATE/feature_request.md | 8 ++++++++ 3 files changed, 19 insertions(+), 12 deletions(-) rename ISSUE_TEMPLATE.md => .github/ISSUE_TEMPLATE/bug_report.md (66%) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/bug_report.md similarity index 66% rename from ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/bug_report.md index d851750f..fc68281b 100644 --- a/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -12,18 +12,11 @@ Github binary releases. Replace this text with your operating system and version. -#### Describe your question, feature request, or bug. +#### Describe your bug. -If a question, please describe the problem you're trying to solve and give -as much context as possible. +Give a high level description of the bug. -If a feature request, please describe the behavior you want and the motivation. -Please also provide an example of how ripgrep would be used if your feature -request were added. - -If a bug, please see below. - -#### If this is a bug, what are the steps to reproduce the behavior? +#### 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 @@ -32,7 +25,7 @@ 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? +#### What is the actual behavior? Show the command you ran and the actual output. Include the `--debug` flag in your invocation of ripgrep. @@ -48,6 +41,6 @@ goes here ``` -#### If this is a bug, what is the expected behavior? +#### 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.