Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101
0 likes1,533 views
The document provides a guide on writing effective commit messages in version control systems, emphasizing clarity and structure. Key recommendations include separating the subject from the body, limiting subject line length, and explaining the reasons for changes rather than the methods. Additionally, it suggests creating atomic commits and utilizing bullet points for clarity.
Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101
- 1. Commit Messages 101 A Short Story About The Reading And Writing of Books Benjamin Wolf @ichaos1985 Photo by kellepics on Pixabay
- 2. „Reading good code is like reading a good book.“ Benjamin Wolf Senior Consultant at INNOQ Develops applications in Java / .NET Loves software quality Coffee snob
- 3. Photo by Emily Morter on Unsplash The Recipe of Good Commit Messages
- 4. Story Warm, sunny. Was day. Silence is utter and complete. Wizard, staff, travel book. Touched the ground (staff). Roared. Find monster despite veil. Got away. Unrealistic, unharmed. Recovered staff, straightening, turning the threat.
- 5. A Wizard’s Tale It was a warm and sunny day. Only the utter and complete silence seemed off. The Wizard carefully put his staff down and opened his travel book. The moment his staff touch the ground, a roar resounded from behind. Obviously, the monster had found him despite his magical veil. Getting away completely unharmed seemed unrealistic. He recovered his staff, straightened himself and turned to face the threat.
- 6. Tweet by Denis Kyorov on TwitterTweet by Denis Kyorov on Twitter
- 7. Photo by Emily Morter on Unsplash
- 8. Style Photo by Nafinia Putra on Unsplash
- 9. Content Photo by Sindre Aalberg on Unsplash
- 10. Metadata Photo by Jingyi Wang on Unsplash
- 11. Chapter 1 Separate subject from body with a blank line
- 12. Chapter 2 Limit the subject line to 50 characters
- 13. Chapter 3 Capitalise the subject line
- 14. Chapter 4 Do not end the subject line with a period
- 15. Chapter 5 Use the imperative mood in the subject line
- 16. Chapter 6 Wrap the body at 72 characters
- 17. Chapter 7 Use the body to explain what and why vs. how
- 18. Summarise changes in around 50 characters or less More detailed explanatory text, if necessary. Wrap it to about 72 characters or so. In some contexts, the first line is treated as the subject of the commit and the rest of the text as the body. The blank line separating the summary from the body is critical (unless you omit the body entirely); various tools like ‘log’, ‘shortlog’ and ‘rebase’ can get confused if you run the two together. Explain the problem that this commit is solving. Focus on why you are making this change as opposed to how (the code explains that). Are there side effects or other unintuitive consequences of this change? Here's the place to explain them. Source: Chris Beams on chris.beams.io
- 19. Further paragraphs come after blank lines. - Bullet points are okay, too - Typically a hyphen or asterisk is used for the bullet, preceded by a single space, with blank lines in between, but conventions vary here If you use an issue tracker, put references to them at the bottom, like this: Resolves: #123 See also: #456, #789 Source: Chris Beams on chris.beams.io
- 20. What you do… Some bugs fixed Fixed bugs Some little changes Changed a little Small fixes Fixes XYZ F*CK! Had to revert!
- 21. (Applying this commit will) (Applying this commit will) (Applying this commit will) (Applying this commit will) (Applying this commit will) (Applying this commit will) (Applying this commit will) What you SHOULD do… Fix some of our most crucial bugs Fix bug caused by user input on empty page Adjust some parts of the new layout Change the layout a bit Fix smaller issues (see #301) Fix a rare (and evil) NullReferenceException Revert changes due to unexpected behaviour
- 22. Real world examples when things went sideways
- 24. Thank you for using <AppName>! We’re always working hard to make the app faster and better than ever. Update to the most recent version to get the best experience of <AppName>. Love the app? Rate us! Your feedback helps us to continuously improve <AppName>.
- 26. Create atomic commits Write commit messages
- 27. Create atomic commits Write commit messages Write good commit messages
- 28. Commit Messages 101 A Short Story About The Reading And Writing of Books Benjamin Wolf @ichaos1985 Photo by kellepics on Pixabay
- 29. Resources • Cover page, last page: Photo by Nicole Honeywill on Unsplash, https://unsplash.com/photos/_-hjiem5TqI • Page 7, “Where is the Love“, Photo by Emily Morter on Unsplash, https://unsplash.com/photos/8xAA0f9yQnE • Page 8, “Latte art and laptop“, Photo by Nafinia Putra on Unsplash, https://unsplash.com/photos/k7BdNN6TwFo • Page 9, “Round storage“, Photo by Sindre Aalberg on Unsplash, https://unsplash.com/photos/mEr7U5yfYt8 • Page 10, “Network everything“, Photo by Jingyi Wang on Unsplash, https://unsplash.com/photos/avKPLHgASBM • Page 11-17, “Open Empty Book“, Photo by John Schnobrich on Unsplash, https://unsplash.com/photos/bNCKsUyQYmM • Pages 11-19: „How to write a commit message“, Chris Beams on https://chris.beams.io/posts/git-commit/, CC BY-SA 4.0 • Black Book, Photo by Kelly Sikkema on Unsplash