Skip to content

Commit

Permalink
Add Git Commit Message Template to the Repository (#94)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
franziska-wegner committed Jan 5, 2024
1 parent 82370d5 commit 0acf774
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .gitconfig
Original file line number Diff line number Diff line change
@@ -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
24 changes: 24 additions & 0 deletions .gitmessage
Original file line number Diff line number Diff line change
@@ -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 ... <if change is obvious omit this part>

* ...

##################################
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.

0 comments on commit 0acf774

Please sign in to comment.