diff options
author | w0rp <devw0rp@gmail.com> | 2018-07-01 20:41:52 +0100 |
---|---|---|
committer | w0rp <devw0rp@gmail.com> | 2018-07-01 20:41:52 +0100 |
commit | 1c5c4a4c8ed88555000ece0f0b3806cbf012c2d1 (patch) | |
tree | 1f554425969ae4600146db56efed85a89e2d936d | |
parent | 059c5cfca491a59efff55d4e9ad59b8d30e0fdec (diff) | |
download | ale-1c5c4a4c8ed88555000ece0f0b3806cbf012c2d1.zip |
Split the issue template into multiple files
-rw-r--r-- | .gitattributes | 1 | ||||
-rw-r--r-- | ISSUE_TEMPLATE.md | 28 | ||||
-rw-r--r-- | ISSUE_TEMPLATE/bugs.md | 40 | ||||
-rw-r--r-- | ISSUE_TEMPLATE/enhancements.md | 7 | ||||
-rw-r--r-- | ISSUE_TEMPLATE/integration.md | 20 |
5 files changed, 68 insertions, 28 deletions
diff --git a/.gitattributes b/.gitattributes index 05b1f3f0..b1235f82 100644 --- a/.gitattributes +++ b/.gitattributes @@ -2,6 +2,7 @@ /CODE_OF_CONDUCT.md export-ignore /CONTRIBUTING.md export-ignore /Dockerfile export-ignore +/ISSUE_TEMPLATE export-ignore /ISSUE_TEMPLATE.md export-ignore /Makefile export-ignore /PULL_REQUEST_TEMPLATE.md export-ignore diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 0276a659..00000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,28 +0,0 @@ -<!-- - This is a template for bug reports. If you want to request a new feature, - you can clear this entire form field and write a short description of what - you want. ---> - -## Information - -**VIM version** - -PASTE JUST THE FIRST TWO LINES OF `:version` HERE. - -Operating System: WHAT OS WERE YOU USING? - -### :ALEInfo - -PASTE OUTPUT OF `:ALEInfo` HERE. YOU CAN TRY `:ALEInfoToClipboard`. - -## What went wrong - -WRITE WHAT WENT WRONG HERE. - -## Reproducing the bug - -Steps for repeating the bug: - -1. Write a list of steps. -2. Otherwise nobody will fix the bug. diff --git a/ISSUE_TEMPLATE/bugs.md b/ISSUE_TEMPLATE/bugs.md new file mode 100644 index 00000000..43b67fba --- /dev/null +++ b/ISSUE_TEMPLATE/bugs.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/ISSUE_TEMPLATE/enhancements.md b/ISSUE_TEMPLATE/enhancements.md new file mode 100644 index 00000000..855a6493 --- /dev/null +++ b/ISSUE_TEMPLATE/enhancements.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. --> diff --git a/ISSUE_TEMPLATE/integration.md b/ISSUE_TEMPLATE/integration.md new file mode 100644 index 00000000..92e1d6f3 --- /dev/null +++ b/ISSUE_TEMPLATE/integration.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. +--> |