I personally don't entirely agree with the statement: "Just by reading it, you will be able to remember what you did in this part of your work."
I always repeat that commit messages should be written not to yourself, but for others. A better philosophy would be: "Just by reading it, anyone will be able to clearly understand what you did in this part of your work."
The ability to remember yourself is a natural side-effect of a well-written commit message.
You're right! This is what I wanted to mean, but I'm not a native English speaker, maybe it is the reason why I misspoke myself.
When I wrote this guide, it was with the idea of creating a good commit message to mainly improve the collaboration and the productivity (ref: "Why is it essential to write your commit well").
Thank you for your feedback and the proposal!
I update this part of the article right now with your sentence.
I personally don't entirely agree with the statement: "Just by reading it, you will be able to remember what you did in this part of your work."
I always repeat that commit messages should be written not to yourself, but for others. A better philosophy would be: "Just by reading it, anyone will be able to clearly understand what you did in this part of your work."
The ability to remember yourself is a natural side-effect of a well-written commit message.
Hello @llcamara ,
You're right! This is what I wanted to mean, but I'm not a native English speaker, maybe it is the reason why I misspoke myself.
When I wrote this guide, it was with the idea of creating a good commit message to mainly improve the collaboration and the productivity (ref: "Why is it essential to write your commit well").
Thank you for your feedback and the proposal!
I update this part of the article right now with your sentence.
Don't get me wrong, I really liked your article and I did understood your points about the importance of collaboration as it went on.
My comment was just a small improvement suggestion, that further reinforces this idea. I'm happy if it helps somehow :)
Don't worry, I didn't take it wrong! 😊
I love receiving feedback from my readers; it's an excellent way to improve the quality of my article.
Anyway, I'm glad you liked the article! Thank you for your help! 😀