diff options
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d2f6952 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing + +Before making a pull request +1. Tidy your commits into the format below +2. Deploy the playbook your self (if you have permissions) +3. Does it work? If not, fix it and goto 1 +4. Create a pull request :) + +## Commit style + +Please create commits for each logical change, +and use this format for your git commits + +``` +<role>: <task>: <change headline> + +< more descriptive text > +``` +example: +``` +jumbotron: irssi: cleanup .irssi/config + +Consistently indent everything with 2 spaces, +and add a newline at end of file. +``` |