summaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authorEthan P <eth-p+git@hidden.email>2020-02-22 18:34:57 -0800
committerDavid Peter <sharkdp@users.noreply.github.com>2020-02-28 08:03:13 +0100
commit63f6343cf137b97dc39f84c1a2312e83cc0ba32e (patch)
tree93d592e8955bd1187fa92ee72800c307cb6314d5 /.github
parentad42b275a936b9ac07c9dcb292dcb958f683480a (diff)
Add issue templates
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md40
-rw-r--r--.github/ISSUE_TEMPLATE/syntax_request.md23
2 files changed, 63 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..56de1409
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,40 @@
+---
+name: Bug Report
+about: Report a bug.
+title: "[Bug] "
+labels: bug
+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
+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.
+
+**Once you're done:**
+Please remove this header and continue.
+\-------------------------------------------------------------------------------------------------
+
+**What do you expect to happen?**
+...
+
+**What actually happens?**
+...
+
+**How did you install `bat`?**
+apt-get, homebrew, GitHub release, etc.
+
+**If applicable, can you tell us more about your system?**
+...
+
diff --git a/.github/ISSUE_TEMPLATE/syntax_request.md b/.github/ISSUE_TEMPLATE/syntax_request.md
new file mode 100644
index 00000000..eb8bda3b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/syntax_request.md
@@ -0,0 +1,23 @@
+---
+name: Syntax Request
+about: Request adding a new syntax to bat.
+title: "[Syntax Request] "
+labels: new-syntax
+assignees: ''
+
+---
+
+\-------------------------------------------------------------------------------------------------
+**BEFORE YOU MAKE A REQUEST:**
+
+Are you looking to add a new syntax to use on one of your devices?
+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.
+\-------------------------------------------------------------------------------------------------
+
+
+**Syntax:** syntax/language name
+