summaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authorEthan P <eth-p+git@hidden.email>2020-02-23 14:46:20 -0800
committerDavid Peter <sharkdp@users.noreply.github.com>2020-02-28 08:03:13 +0100
commit5faf7ca158356fdb43e71a4244783b7cae136830 (patch)
tree02466683fd4a4c69d31e7a0c7c255a254566cfbe /.github
parentebe475247c736db09e8d8a3af1aa203419b95972 (diff)
Change ISSUE_TEMPLATE files based on feedback in #837
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md22
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml2
-rw-r--r--.github/ISSUE_TEMPLATE/syntax_request.md10
3 files changed, 23 insertions, 11 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 56de1409..34b71cbd 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -8,28 +8,30 @@ assignees: ''
---
\-------------------------------------------------------------------------------------------------
-**IS THIS BUG RELATED TO EXTERNAL TOOLS? (e.g. git, less, etc.)**
-
-If it is, there's a good chance we might need to know a little bit more about the environment
+**Hey there, thanks for creating an issue!**
+In order to replicate your issue, we might need to know a little bit more about the environment
which you're running `bat` on.
-**If you're on Windows:**
-Please tell us about your:
-
-- Windows Version
-
**If you're on Linux or MacOS:**
Please run the script at https://github.com/sharkdp/bat/blob/diag-tools/diagnostics/info.sh and
paste the output at the bottom of the bug report.
+**If you're on Windows:**
+Please tell us about the following at the bottom of the bug report:
+
+- Windows Version (e.g. "Windows 10 1908")
+
**Once you're done:**
Please remove this header and continue.
\-------------------------------------------------------------------------------------------------
-**What do you expect to happen?**
+**What version of `bat` are you using?**
+[paste the output of `bat --version` here]
+
+**Describe the bug you encountered:**
...
-**What actually happens?**
+**Describe what you expected to happen?**
...
**How did you install `bat`?**
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000..b92c70cb
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,2 @@
+blank_issues_enabled: true
+
diff --git a/.github/ISSUE_TEMPLATE/syntax_request.md b/.github/ISSUE_TEMPLATE/syntax_request.md
index eb8bda3b..aabf3e71 100644
--- a/.github/ISSUE_TEMPLATE/syntax_request.md
+++ b/.github/ISSUE_TEMPLATE/syntax_request.md
@@ -15,9 +15,17 @@ Bat supports locally-installed language definitions. See the link below:
https://github.com/sharkdp/bat#adding-new-syntaxes--language-definitions
-If you think adding this syntax would help others as well, please remove this header and continue.
+If you think adding this syntax would help others as well, please make sure that it meets our
+guidelines for adding new syntaxes:
+
+ - 10,000 downloads on packagecontrol.io
+
+Once you have confirmed that it meets our guidelines, you can remove this header and continue.
\-------------------------------------------------------------------------------------------------
**Syntax:** syntax/language name
+**Guideline Criteria:**
+[packagecontro.io link here]
+