summaryrefslogtreecommitdiff
path: root/.github/CONTRIBUTING.md
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2018-07-22 12:10:35 +0100
committerw0rp <devw0rp@gmail.com>2018-07-22 12:10:35 +0100
commit014c924630c38afcc402902ed712b54ff232d861 (patch)
tree68cf7ee8ac5a89267f8c1a7d1b834030cf578a96 /.github/CONTRIBUTING.md
parent04fbea6e80e010ffc242cc13daed6279f5d5aadf (diff)
downloadale-014c924630c38afcc402902ed712b54ff232d861.zip
Move GitHub files to the .github directory
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r--.github/CONTRIBUTING.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 00000000..e59f8326
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,25 @@
+## Guidelines
+
+Have fun, and work on whatever floats your boat. Take It Easy :tm:.
+
+For help with contributing to ALE, see `:help ale-development` in Vim, or view
+the help file online [here](/w0rp/ale/blob/master/doc/ale-development.txt).
+
+## Creating Issues
+
+Before creating any issues, please look through the current list of issues and
+pull requests, and ensure that the issue hasn't already been reported. If an
+issue has already been reported, but you have some new insight, please add
+a comment to the existing issue.
+
+Please read the FAQ in the README before creating any issues. A feature
+you desire may already exist and be documented, or the FAQ might explain
+how to solve a problem you have already.
+
+Please try and describe any issues reported with as much detail as you can
+provide about your Vim version, the linter you were trying to run, your
+operating system, or any other information you think might be helpful.
+
+Please describe your issue in clear, grammatically correct, and easy to
+understand English. You are more likely to see an issue resolved if others
+can understand you.