Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
Commit Messages 101
A Short Story About The Reading
And Writing of Books
Benjamin Wolf
@ichaos1985
Photo by kellepics on P...
„Reading good code
is like reading
a good book.“
Benjamin Wolf
Senior Consultant
at INNOQ
Develops applications in Java / ...
Photo by Emily Morter on Unsplash
The Recipe of
Good
Commit Messages
Story
Warm, sunny. Was day.
Silence is utter and complete.
Wizard, staff, travel book.
Touched the ground (staff). Roared....
A Wizard’s Tale
It was a warm and sunny day.
Only the utter and complete silence seemed off.
The Wizard carefully put his ...
Tweet by Denis Kyorov on TwitterTweet by Denis Kyorov on Twitter
Photo by Emily Morter on Unsplash
Style
Photo by Nafinia Putra on Unsplash
Content
Photo by Sindre Aalberg on Unsplash
Metadata
Photo by Jingyi Wang on Unsplash
Chapter 1
Separate subject
from body
with a blank line
Chapter 2
Limit the
subject line to
50 characters
Chapter 3
Capitalise
the subject line
Chapter 4
Do not end
the subject line

with a period
Chapter 5
Use the
imperative mood

in the subject line
Chapter 6
Wrap the body

at 72 characters
Chapter 7
Use the body
to explain

what and why
vs. how
Summarise changes in around 50 characters or less
More detailed explanatory text, if necessary. Wrap it to
about 72 charac...
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the ...
What you do…
Some bugs fixed
Fixed bugs
Some little changes
Changed a little
Small fixes
Fixes XYZ
F*CK! Had to revert!
(Applying this commit will)
(Applying this commit will)
(Applying this commit will)
(Applying this commit will)
(Applying ...
Real world examples
when things went sideways
Thank you for using <AppName>! We’re always
working hard to make the app faster and
better than ever. Update to the most r...
Create atomic commits
Create atomic commits
Write commit messages
Create atomic commits
Write commit messages
Write good commit messages
Commit Messages 101
A Short Story About The Reading
And Writing of Books
Benjamin Wolf
@ichaos1985
Photo by kellepics on P...
Resources
• Cover page, last page: Photo by Nicole Honeywill on Unsplash, https://unsplash.com/photos/_-hjiem5TqI
• Page 7...
Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101
Upcoming SlideShare
Loading in …5
×

of

Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 1 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 2 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 3 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 4 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 5 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 6 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 7 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 8 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 9 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 10 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 11 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 12 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 13 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 14 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 15 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 16 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 17 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 18 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 19 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 20 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 21 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 22 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 23 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 24 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 25 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 26 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 27 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 28 Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101 Slide 29
Upcoming SlideShare
What to Upload to SlideShare
Next
Download to read offline and view in fullscreen.

0 Likes

Share

Download to read offline

Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101

Download to read offline

Commit-Messages wie etwa “some fixes” bei mehr als 200 betroffenen Dateien und mehr als 70.000 geänderten Zeilen Code sind nicht hilfreich. Im Gegenteil.
Sie sind extrem schädlich.

In diesem Lightning Talk erkläre ich, weshalb Entwickler*innen oft an Commit-Messages scheitern und wie ihr mit gezielten Fragen sowie mit sieben kleinen Regeln in Zukunft großartige Nachrichten für euch und euer Team schreiben könnt.

Related Books

Free with a 30 day trial from Scribd

See all

Related Audiobooks

Free with a 30 day trial from Scribd

See all
  • Be the first to like this

Dev Day 2019: Benjamin Wolf – "Some fixes" - Commit Message 101

  1. 1. Commit Messages 101 A Short Story About The Reading And Writing of Books Benjamin Wolf @ichaos1985 Photo by kellepics on Pixabay
  2. 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. 3. Photo by Emily Morter on Unsplash The Recipe of Good Commit Messages
  4. 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. 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. 6. Tweet by Denis Kyorov on TwitterTweet by Denis Kyorov on Twitter
  7. 7. Photo by Emily Morter on Unsplash
  8. 8. Style Photo by Nafinia Putra on Unsplash
  9. 9. Content Photo by Sindre Aalberg on Unsplash
  10. 10. Metadata Photo by Jingyi Wang on Unsplash
  11. 11. Chapter 1 Separate subject from body with a blank line
  12. 12. Chapter 2 Limit the subject line to 50 characters
  13. 13. Chapter 3 Capitalise the subject line
  14. 14. Chapter 4 Do not end the subject line
 with a period
  15. 15. Chapter 5 Use the imperative mood
 in the subject line
  16. 16. Chapter 6 Wrap the body
 at 72 characters
  17. 17. Chapter 7 Use the body to explain
 what and why vs. how
  18. 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. 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. 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. 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. 22. Real world examples when things went sideways
  23. 23. 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>.
  24. 24. Create atomic commits
  25. 25. Create atomic commits Write commit messages
  26. 26. Create atomic commits Write commit messages Write good commit messages
  27. 27. Commit Messages 101 A Short Story About The Reading And Writing of Books Benjamin Wolf @ichaos1985 Photo by kellepics on Pixabay
  28. 28. 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

Commit-Messages wie etwa “some fixes” bei mehr als 200 betroffenen Dateien und mehr als 70.000 geänderten Zeilen Code sind nicht hilfreich. Im Gegenteil. Sie sind extrem schädlich. In diesem Lightning Talk erkläre ich, weshalb Entwickler*innen oft an Commit-Messages scheitern und wie ihr mit gezielten Fragen sowie mit sieben kleinen Regeln in Zukunft großartige Nachrichten für euch und euer Team schreiben könnt.

Views

Total views

1,465

On Slideshare

0

From embeds

0

Number of embeds

130

Actions

Downloads

1

Shares

0

Comments

0

Likes

0

×