summaryrefslogtreecommitdiff
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
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
-rw-r--r--CONTRIBUTING.md13
-rw-r--r--contrib/README.md9
-rw-r--r--contrib/commit-template.txt7
-rw-r--r--contrib/leap-commit-template20
4 files changed, 33 insertions, 16 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
diff --git a/contrib/README.md b/contrib/README.md
deleted file mode 100644
index e836bc7e..00000000
--- a/contrib/README.md
+++ /dev/null
@@ -1,9 +0,0 @@
-# Contributed Files
-
-## Commit Template
-
-to install this commit template, use following cmd (use --global to use it in your global .gitconfig):
-
- git config [--global] commit.template "~/path_to_leap_platform/contrib/commit-template.txt"
-
-
diff --git a/contrib/commit-template.txt b/contrib/commit-template.txt
deleted file mode 100644
index 9a1fa81b..00000000
--- a/contrib/commit-template.txt
+++ /dev/null
@@ -1,7 +0,0 @@
-#[bug|feat|docs|style|refactor|test|pkg|i18n]
-
-#- Tested: [local singlenode|local multinode|citest|unstable.bitmask.net]
-#- Resolves: #XYZ
-#- Related: #XYZ
-#- Documentation: #XYZ
-#- Releases: XYZ
diff --git a/contrib/leap-commit-template b/contrib/leap-commit-template
new file mode 100644
index 00000000..afc56b2b
--- /dev/null
+++ b/contrib/leap-commit-template
@@ -0,0 +1,20 @@
+# Bug|Feat|CI|Docs|Style|Tests|I18n|Vagrant|Lint: [style: https://github.com/m1foley/fit-commit]
+
+
+# [Story about your commit.]
+
+# Use one or more of these things:
+# - Fixes|Closes #3210
+# - Related: #1234
+
+#example:
+#    
+#   Bug: fix apache systemd insanity
+#    
+#   Apache2 systemd autorestart was failing because of #2314432
+#   and it was caused by a gremlin that was entering through a wormhole
+#   caused by #985843, so this commit resolves this wormhole
+#    
+#    # Use one of these things:
+#    [- Fixes|Closes #5234]
+#    [- Related: #1234]