summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2016-10-25 17:41:34 +0100
committerw0rp <devw0rp@gmail.com>2016-10-25 17:41:34 +0100
commit1bcee7ef33ffd2da752e85177bfa215c60f98e71 (patch)
treef37218e3879aa358d0024d83434f1304ce10d4ac /CONTRIBUTING.md
parent454dbbe33e9d64ccddab20a38a00cbd215058513 (diff)
downloadale-1bcee7ef33ffd2da752e85177bfa215c60f98e71.zip
Mention the Google Vimscript Style Guide in the contributing file.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e263d37f..6ab1dc5f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -10,6 +10,11 @@
Have fun, and work on whatever floats your boat. Take It Easy :tm:.
+When writing code, follow the [Google Vimscript Style Guide](https://google.github.io/styleguide/vimscriptguide.xml), and
+run `vint -s` on your files to check for most of what the guide mentions and more. If you install this plugin and install
+[Vint](https://github.com/Kuniwak/vint), it will check your code while you type.
+
+
<a name="pull-requests"></a>
# 2. Creating Pull Requests