Skip to content

Commit

Permalink
Add git commit message template to the repository
Browse files Browse the repository at this point in the history
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
  • Loading branch information
franziska-wegner committed Jan 5, 2024
1 parent 71faeb6 commit 6848319
Showing 1 changed file with 24 additions and 0 deletions.
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 6848319

Please sign in to comment.