From b03c6f3da92615977a604bcf8a482339d3b6ce0b Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 23 Sep 2015 12:26:26 -0400 Subject: [docs] small additions to CONTRIBUTING --- CONTRIBUTING.rst | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) (limited to 'CONTRIBUTING.rst') 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] -- cgit v1.2.3