summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvarac <varacanero@zeromail.org>2015-03-17 11:34:11 +0100
committervarac <varacanero@zeromail.org>2015-03-17 11:34:11 +0100
commite7313cf255cfe4ebaab7b27e41eddd98285977fc (patch)
tree1a13d131f9ba079baedc8f964c33c870144e603c
parent6d4dcb83118e3d88aed49347690babd69eb56c91 (diff)
updated README.md with contributing section how to use a pre-commit hook for syntax and style guide checking
Change-Id: Ia03321d71cce39f643ec7248361c156e34fe0d09
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index c3770de6..1d58b5eb 100644
--- a/README.md
+++ b/README.md
@@ -78,6 +78,15 @@ Special Environments
. When deploying to OpenStack release "nova" or newer, you will need to do an initial deploy, then when it has finished run `leap facts update` and then deploy again (see: https://leap.se/code/issues/3020)
+Contributing
+============
+
+In order to validate the syntax and style guide compliance
+before you commit,
+clone https://github.com/pixelated-team/puppet-git-hooks.git
+and link `pre-commit` to `.git/hooks/pre-commit`.
+
+
Changelog
=========