From 27d7a0ffff1623572a642f3e45db3fc556dafec3 Mon Sep 17 00:00:00 2001
From: Stephan Seitz <stephan.seitz@fau.de>
Date: Sun, 5 Jul 2020 20:45:46 +0200
Subject: Add style-check script

---
 CONTRIBUTING.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'CONTRIBUTING.md')

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index af48cdc62..47dcb9f83 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -11,6 +11,18 @@ As you know, `nvim-treesitter` is roughly splitted in two parts :
 
 Depending on which part of the plugin you want to contribute to, please read the appropriate section.
 
+## Style Checks and Tests
+
+We haven't implemented any functionality tests yet. Feel free to contribute.
+However, we check code style with `luacheck`!
+Please install luacheck and activate our `pre-push` hook to automatically check style before
+every push:
+
+```bash
+luarocks install luacheck
+ln -s ../../scripts/pre-push .git/hooks/pre-push
+```
+
 ## Parser configurations
 
 Contributing to parser configurations is basically modifying one of the `queries/*/*.scm`.
-- 
cgit v1.2.3-70-g09d2