From 9365cd2c8cdf70ea24b382cd547fb94f8d403b2f Mon Sep 17 00:00:00 2001 From: kwadronaut Date: Tue, 11 Jul 2017 21:29:55 +0200 Subject: Style: updates a git commit template A nice readable git history is always appreciated. By nudging people in using our template, we hope to achieve that. Through the inclusion of a CONTRIBUTING.md we hope to make that easier. - Fixes #8845 --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..6ae7f6ca --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# Contributed Files + +## Commit Template + +To install our commit template, use following command (use --global to use it in your global .gitconfig): + + git config [--global] commit.template "~/path_to_leap_platform/contrib/leap-commit-template" + +## Signing commits + +We very much appreciate signed commits, you can stop forgetting it like this: + + git config [--global] commit.gpgSign -- cgit v1.2.3