Add Git Commit Message Template to the Repository #94
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
franziska-wegner
added
documentation
franziska-wegner
added this to the Add Evaluation Scripts to make Research Reproducible milestone
franziska-wegner
removed this from the Add Evaluation Scripts to make Research Reproducible milestone
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #94 +/- ##
=======================================
Coverage 94.57% 94.57%
=======================================
Files 55 55
Lines 5050 5050
=======================================
Hits 4776 4776
Misses 274 274 ☔ View full report in Codecov by Sentry. |
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
franziska-wegner
force-pushed
the
franziska-wegner/2024/january/git/git-message-for-commits
branch
from
543276a
to
851a3ca
Compare
franziska-wegner
deleted the
franziska-wegner/2024/january/git/git-message-for-commits
branch
github-actions bot
added a commit
that referenced
this pull request
Jan 5, 2024
* 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 0acf774
github-actions bot
added a commit
that referenced
this pull request
Jan 5, 2024
* 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 0acf774
github-actions bot
added a commit
that referenced
this pull request
Jan 5, 2024
* 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 0acf774
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a common commit message template that should be used for this repository. The questions help in identifying major problems with the commit beforehand and help in the aftermath to understand certain decision years after the commit if necessary. The repository dependent
.gitconfigneeds to be included withgit config --local include.path ./.gitconfigto make this work.The resources of the message are given in [1-5].
The template in [6] appears to me also very useful as well as the description of [7]. The latter describes the usage of multiple templates that are use case dependent, if I understand it correctly.
Changes to be committed:
Literature
[1] https://thoughtbot.com/blog/better-commit-messages-with-a-gitmessage-template
[2] https://thoughtbot.com/blog/5-useful-tips-for-a-better-commit-message
[3] https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository
[4] https://www.youtube.com/watch?v=PJjmw9TRB7s
[5] https://www.amazon.com/gp/product/B07MNKZJR9/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=B07MNKZJR9&linkCode=as2&tag=initialcommit-20&linkId=21a8f51af6f217c290a950ce506fba59
[6] https://embeddedartistry.com/blog/2017/08/04/a-github-pull-request-template-for-your-projects/
[7] https://learn.microsoft.com/en-us/azure/devops/repos/git/pull-request-templates?view=azure-devops