summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorkwadronaut <kwadronaut@leap.se>2017-07-11 21:29:55 +0200
committerkwadronaut <kwadronaut@leap.se>2017-07-11 21:37:25 +0200
commit9365cd2c8cdf70ea24b382cd547fb94f8d403b2f (patch)
tree521e6ce34f538f3dbc8d7aed8be1cb7b2723f750 /CONTRIBUTING.md
parentff3878a70235206d182116c74c4ac7b3cc1a478f (diff)
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
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md13
1 files changed, 13 insertions, 0 deletions
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