From 0acf774db83be1ded513364931e6e5930768cdd3 Mon Sep 17 00:00:00 2001 From: Franziska Wegner <57569315+franziska-wegner@users.noreply.github.com> Date: Fri, 5 Jan 2024 04:59:22 -0800 Subject: [PATCH] Add Git Commit Message Template to the Repository (#94) * Add git commit message template to the repository * Why: * This helps to have a common commit message structure, * This also helps to identify problems while writing the answers to these questions. * Changes to be committed: * new file: .gitmessage * Add repository git config that includes the git commit message template * What: * This file needs to be included by each developer using the local command to have it repository dependent * Use: * git config --local include.path ./.gitconfig * Changes to be committed: * new file: .gitconfig --- .gitconfig | 9 +++++++++ .gitmessage | 24 ++++++++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 .gitconfig create mode 100644 .gitmessage diff --git a/.gitconfig b/.gitconfig new file mode 100644 index 00000000..a654810b --- /dev/null +++ b/.gitconfig @@ -0,0 +1,9 @@ +# Include this file in your workflow with `git config --local include.path ./.gitconfig` +[commit] + gpgsign = true + template = ./.gitmessage +[filter "lfs"] + clean = git-lfs clean -- %f + smudge = git-lfs smudge -- %f + process = git-lfs filter-process + required = true diff --git a/.gitmessage b/.gitmessage new file mode 100644 index 00000000..b9b7e007 --- /dev/null +++ b/.gitmessage @@ -0,0 +1,24 @@ +Title of the commit message + +################################## +Why: +## Why is the change necessary? +## What does the reviewer of my put request expect in the commit, help them to easily identify and point out unrelated changes! + +* ... + +################################## +This change addresses the need by: +## How does it address the issue? Like performance improvements, or bugs, or ... + +* ... + +################################## +What side effects does this change have? +## To many points here means a to large commit! (1 or 2 is fine) + +* ... + +# 50-character subject line +# +# 72-character wrapped longer description.