summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorw0rp <w0rp@users.noreply.github.com>2018-07-01 20:50:29 +0100
committerw0rp <w0rp@users.noreply.github.com>2018-07-01 20:50:29 +0100
commit8ac43b19364c1a86d7ac01b0eda28db296471cfa (patch)
tree14876b33a0c3251fc067532f5180d872f5b4000b /.github
parent1c5c4a4c8ed88555000ece0f0b3806cbf012c2d1 (diff)
downloadale-8ac43b19364c1a86d7ac01b0eda28db296471cfa.zip
Update issue templates
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/custom.md7
-rw-r--r--.github/ISSUE_TEMPLATE/report-a-bug.md40
-rw-r--r--.github/ISSUE_TEMPLATE/suggest-a-new-linter-or-fixer.md20
-rw-r--r--.github/ISSUE_TEMPLATE/suggest-an-improvement.md7
4 files changed, 74 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md
new file mode 100644
index 00000000..99bb9a00
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/custom.md
@@ -0,0 +1,7 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+
+---
+
+
diff --git a/.github/ISSUE_TEMPLATE/report-a-bug.md b/.github/ISSUE_TEMPLATE/report-a-bug.md
new file mode 100644
index 00000000..cf335c11
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/report-a-bug.md
@@ -0,0 +1,40 @@
+---
+name: Report a bug
+about: Report a bug with ALE.
+
+---
+
+<!--
+ This is the template for reporting ALE bugs. Make sure you try updating ALE
+ to a more recent version before reporting a bug. Look through existing bug
+ reports for similar issues before reporting a new one. Don't leave comments
+ about new bugs in the comment section for old issues.
+
+ Make sure to try disabling other plugins and trying to repeat your bug before
+ reporting it in ALE. Some times problems can arise when two plugins are used
+ together, but often your issues might be problems with other plugins.
+-->
+
+## Information
+
+**VIM version**
+
+<!-- Paste just the first two lines of :version here. -->
+
+Operating System: <!-- Describe your operating system version. -->
+
+### :ALEInfo
+
+<!-- Paste the output of :ALEInfo here. Try :ALEInfoToClipboard -->
+<!-- Make sure to run :ALEInfo from the buffer where the bug occurred. -->
+
+## What went wrong
+
+<!-- Describe what went wrong here. -->
+
+## Reproducing the bug
+
+<!-- Write a list of steps below. -->
+
+1. I did this.
+2. Then this happened.
diff --git a/.github/ISSUE_TEMPLATE/suggest-a-new-linter-or-fixer.md b/.github/ISSUE_TEMPLATE/suggest-a-new-linter-or-fixer.md
new file mode 100644
index 00000000..75c7637f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/suggest-a-new-linter-or-fixer.md
@@ -0,0 +1,20 @@
+---
+name: Suggest a new linter or fixer
+about: Suggest a new tool ALE can officially integrate with.
+
+---
+
+<!--
+ Write "Add support for foobar" as the issue title, or similar.
+
+ Fill out the details below.
+-->
+
+**Name:** foobar
+**URL:** https://foo.bar.com
+
+<!--
+ Write a description of the tool, and add any other information you think might
+ be helpful. Consider creating a pull request to add support for the tool
+ yourself.
+-->
diff --git a/.github/ISSUE_TEMPLATE/suggest-an-improvement.md b/.github/ISSUE_TEMPLATE/suggest-an-improvement.md
new file mode 100644
index 00000000..855a6493
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/suggest-an-improvement.md
@@ -0,0 +1,7 @@
+---
+name: Suggest an improvement
+about: Suggest some way to improve ALE, or add a new feature.
+
+---
+
+<!-- There's no fixed format for feature requests. Just add your thoughts. -->