Style: updates a git commit template
authorkwadronaut <kwadronaut@leap.se>
Tue, 11 Jul 2017 19:29:55 +0000 (21:29 +0200)
committerkwadronaut <kwadronaut@leap.se>
Tue, 11 Jul 2017 19:37:25 +0000 (21:37 +0200)
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 [new file with mode: 0644]
contrib/README.md [deleted file]
contrib/commit-template.txt [deleted file]
contrib/leap-commit-template [new file with mode: 0644]

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..6ae7f6c
--- /dev/null
@@ -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 (file)
index e836bc7..0000000
+++ /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 (file)
index 9a1fa81..0000000
+++ /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 (file)
index 0000000..afc56b2
--- /dev/null
@@ -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]