diff options
author | Kali Kaneko <kali@leap.se> | 2015-09-23 12:26:26 -0400 |
---|---|---|
committer | Kali Kaneko <kali@leap.se> | 2015-09-23 12:27:54 -0400 |
commit | b03c6f3da92615977a604bcf8a482339d3b6ce0b (patch) | |
tree | 809926e51135eaf6caf9d6018add216a95f98174 | |
parent | 4077778287c271441290d15317e391b4f2b842d3 (diff) |
[docs] small additions to CONTRIBUTING
-rw-r--r-- | CONTRIBUTING.rst | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b9028c41..f9136de9 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -94,8 +94,10 @@ Pull Requests * Fork our repo * Work your code in a separate branch * Create a pull request against ``develop`` -* Tests should pass -* The code needs to be pep8 compliant +* All tests should pass +* The code needs to be pep8 compliant (run ``pep8 .`` from the top folder) +* Remember to add an entry in the ``changes/`` folder, from where the CHANGELOG + for a given release is gathered. Git Commit Messages ------------------- @@ -114,6 +116,15 @@ http://chris.beams.io/posts/git-commit/ Template for commits -------------------- +You can activate a standard template for your commits on this repo with: + +:: + + git config commit.template docs/leap-commit-template + + +The template looks like this: + :: [type] <subject> |