on master help sign in
Change ISSUE_TEMPLATE files based on feedback in #837
5faf7caEthan P
.github/ISSUE_TEMPLATE/bug_report.md+12−10
@@ -8,28 +8,30 @@ assignees: ''
8---
8---
9
9
10\-------------------------------------------------------------------------------------------------
10\-------------------------------------------------------------------------------------------------
11−**IS THIS BUG RELATED TO EXTERNAL TOOLS? (e.g. git, less, etc.)**
11+**Hey there, thanks for creating an issue!**
12−
13−If it is, there's a good chance we might need to know a little bit more about the environment
12+In order to replicate your issue, we might need to know a little bit more about the environment
14which you're running `bat` on.
13which you're running `bat` on.
15
14
16−**If you're on Windows:**
17−Please tell us about your:
18−
19−- Windows Version
20−
21**If you're on Linux or MacOS:**
15**If you're on Linux or MacOS:**
22Please run the script at https://github.com/sharkdp/bat/blob/diag-tools/diagnostics/info.sh and
16Please run the script at https://github.com/sharkdp/bat/blob/diag-tools/diagnostics/info.sh and
23paste the output at the bottom of the bug report.
17paste the output at the bottom of the bug report.
24
18
19+**If you're on Windows:**
20+Please tell us about the following at the bottom of the bug report:
21+
22+- Windows Version (e.g. "Windows 10 1908")
23+
25**Once you're done:**
24**Once you're done:**
26Please remove this header and continue.
25Please remove this header and continue.
27\-------------------------------------------------------------------------------------------------
26\-------------------------------------------------------------------------------------------------
28
27
29−**What do you expect to happen?**
28+**What version of `bat` are you using?**
29+[paste the output of `bat --version` here]
30+
31+**Describe the bug you encountered:**
30...
32...
31
33
32−**What actually happens?**
34+**Describe what you expected to happen?**
33...
35...
34
36
35**How did you install `bat`?**
37**How did you install `bat`?**
.github/ISSUE_TEMPLATE/config.ymlnew file+2
@@ -0,0 +1,2 @@
1+blank_issues_enabled: true
2+
.github/ISSUE_TEMPLATE/syntax_request.md+9−1
@@ -15,9 +15,17 @@ Bat supports locally-installed language definitions. See the link below:
15
15
16https://github.com/sharkdp/bat#adding-new-syntaxes--language-definitions
16https://github.com/sharkdp/bat#adding-new-syntaxes--language-definitions
17
17
18−If you think adding this syntax would help others as well, please remove this header and continue.
18+If you think adding this syntax would help others as well, please make sure that it meets our
19+guidelines for adding new syntaxes:
20+
21+ - 10,000 downloads on packagecontrol.io
22+
23+Once you have confirmed that it meets our guidelines, you can remove this header and continue.
19\-------------------------------------------------------------------------------------------------
24\-------------------------------------------------------------------------------------------------
20
25
21
26
22**Syntax:** syntax/language name
27**Syntax:** syntax/language name
23
28
29+**Guideline Criteria:**
30+[packagecontro.io link here]
31+