39 how to write a good commit message #41
Conversation
First part 'What is a commit?' done. Upcoming updates will include when to commit and how to.
Explains why good commits are important and how to make a good commit title and body detail
site/posts/how-to-commit/index.qmd
Outdated
| When a change on a program affects the behavior of other programs that also needs to be updated, one commit for all the modifications can be done. Also when you decide to modify both a program and the associated documentation. | ||
|
|
||
| ::: callout-caution | ||
| #### Need feedbacks. |
There was a problem hiding this comment.
I removed the callout.
site/posts/how-to-commit/index.qmd
Outdated
| When a change on a program affects the behavior of other programs that also needs to be updated, one commit for all the modifications can be done. Also when you decide to modify both a program and the associated documentation. | ||
|
|
||
| ::: callout-caution | ||
| #### Need feedbacks. |
|
|
||
| The detail explains **why** the commit needed to be done, the methodological or technical context, or any relevant information that needs to understand the commit. | ||
|
|
||
| It should contains, when relevant, the source (such as a new version of the statistical analysis plan, a decision taken in a meeting minutes, an email, etc), the impact (a modification on a ADaM dataset will have an impact on the TL&F describing the updated variables) or the associated logic. |
There was a problem hiding this comment.
I would also mention in some way that you can link to issues (either inside your git productivity tool - GitHub/GitLab - or outside - e.g. if the sponsor uses a specific issue tracking process, for example for QC issues) in case the "why" is that the update was triggered by some defined process.
There was a problem hiding this comment.
I added a sentence about it.
There was a problem hiding this comment.
@langkabh let me know if you are happy with this then we can get this merged, thanks!
|
I added a small Could you tell me what you think? I can remove it from the post. |
Ready for review. I added some callout in the blog post for feebacks on some parts I'm not sure. But everything can be modified if needed.
Feel free to give me your feedbacks. : )
Closes #39