summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..1eb6d3fd
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,21 @@
+# Contributed Files
+
+## Commit Template
+
+To install our commit template, use following command (use --global to use it in your global .gitconfig):
+
+ git config commit.template "~/path_to_leap_platform/contrib/leap-commit-template"
+
+To use for all projects:
+
+ 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 commit.gpgsign true
+
+To enable for all projects:
+
+ git config --global commit.gpgsign true