Save 37% off PRO during our Black Friday Sale! »

Do Your Commit Messages Suck?

0f5f0ea6a2dc7ed3cb5830377a4fe7e2?s=47 Ryan McGeary
September 08, 2011

Do Your Commit Messages Suck?

BOULDER, CO — Rocky Mountain Ruby 2011 — Software projects are collaborative. They usually encompass many months or years and are touched by several developers along the way.

Communication is key to any good software project. Strong, well written, commit messages are one way to increase communication and documentation with very little overhead.

The project history plus a strong blame engine give us the power to answer future questions about what we were thinking at the time something was added or changed.

0f5f0ea6a2dc7ed3cb5830377a4fe7e2?s=128

Ryan McGeary

September 08, 2011
Tweet

Transcript

  1. Do Your Commit Messages Suck? Ryan McGeary http://ryan.mcgeary.org @rmm5t Friday,

    September 2, 11
  2. The Bad Friday, September 2, 11

  3. dfe4c3e Staging Bad Friday, September 2, 11

  4. dfe4c3e Staging af0a3bb More staging fixes Bad Friday, September 2,

    11
  5. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup Bad Friday, September 2, 11
  6. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More Bad Friday, September 2, 11
  7. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed Bad Friday, September 2, 11
  8. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed dffb0db Again Bad Friday, September 2, 11
  9. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed dffb0db Again 8a0f74c Updated scripts Bad Friday, September 2, 11
  10. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed dffb0db Again 8a0f74c Updated scripts 587a09c deploy script cleanup Bad Friday, September 2, 11
  11. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed dffb0db Again 8a0f74c Updated scripts 587a09c deploy script cleanup 9f474bc More staging Bad Friday, September 2, 11
  12. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed dffb0db Again 8a0f74c Updated scripts 587a09c deploy script cleanup 9f474bc More staging c3f7275 Again more staging Bad Friday, September 2, 11
  13. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed dffb0db Again 8a0f74c Updated scripts 587a09c deploy script cleanup 9f474bc More staging c3f7275 Again more staging 3ee25cd Read from env file Bad Friday, September 2, 11
  14. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed dffb0db Again 8a0f74c Updated scripts 587a09c deploy script cleanup 9f474bc More staging c3f7275 Again more staging 3ee25cd Read from env file 0328c7c again Bad Friday, September 2, 11
  15. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed dffb0db Again 8a0f74c Updated scripts 587a09c deploy script cleanup 9f474bc More staging c3f7275 Again more staging 3ee25cd Read from env file 0328c7c again d5e07c7 whoops Bad Friday, September 2, 11
  16. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed dffb0db Again 8a0f74c Updated scripts 587a09c deploy script cleanup 9f474bc More staging c3f7275 Again more staging 3ee25cd Read from env file 0328c7c again d5e07c7 whoops 0536fc7 Again Bad Friday, September 2, 11
  17. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed dffb0db Again 8a0f74c Updated scripts 587a09c deploy script cleanup 9f474bc More staging c3f7275 Again more staging 3ee25cd Read from env file 0328c7c again d5e07c7 whoops 0536fc7 Again 8af6da0 More Bad Friday, September 2, 11
  18. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed dffb0db Again 8a0f74c Updated scripts 587a09c deploy script cleanup 9f474bc More staging c3f7275 Again more staging 3ee25cd Read from env file 0328c7c again d5e07c7 whoops 0536fc7 Again 8af6da0 More 9052cb8 Again Bad Friday, September 2, 11
  19. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed dffb0db Again 8a0f74c Updated scripts 587a09c deploy script cleanup 9f474bc More staging c3f7275 Again more staging 3ee25cd Read from env file 0328c7c again d5e07c7 whoops 0536fc7 Again 8af6da0 More 9052cb8 Again 7587f8b Working? Bad Friday, September 2, 11
  20. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed dffb0db Again 8a0f74c Updated scripts 587a09c deploy script cleanup 9f474bc More staging c3f7275 Again more staging 3ee25cd Read from env file 0328c7c again d5e07c7 whoops 0536fc7 Again 8af6da0 More 9052cb8 Again 7587f8b Working? 9770886 g Bad Friday, September 2, 11
  21. dfe4c3e Staging af0a3bb More staging fixes e5a524a More staging cap

    setup 19900ba More 0841841 More fixed dffb0db Again 8a0f74c Updated scripts 587a09c deploy script cleanup 9f474bc More staging c3f7275 Again more staging 3ee25cd Read from env file 0328c7c again d5e07c7 whoops 0536fc7 Again 8af6da0 More 9052cb8 Again 7587f8b Working? 9770886 g Bad Friday, September 2, 11
  22. More Bad 3a61755 what a hassle Friday, September 2, 11

  23. More Bad 3a61755 what a hassle eec60db what a stupid

    hassle Friday, September 2, 11
  24. More Bad 3a61755 what a hassle eec60db what a stupid

    hassle bf77372 seriously a fucking hassle Friday, September 2, 11
  25. More Bad 3a61755 what a hassle eec60db what a stupid

    hassle bf77372 seriously a fucking hassle 8b48352 this is a fucking hassle Friday, September 2, 11
  26. More Bad 3a61755 what a hassle eec60db what a stupid

    hassle bf77372 seriously a fucking hassle 8b48352 this is a fucking hassle eb7cdd7 wtf dude Friday, September 2, 11
  27. Again Bad 18c3f84 Huge commit Friday, September 2, 11

  28. Huge Whoops More Again Serious Hassle Bad c1c38fc Update deploy

    recipe with some stuff. I dunno. it's late Friday, September 2, 11
  29. The Good Friday, September 2, 11

  30. Good 0835022 Updated basic auth prompt to reflect app name

    Friday, September 2, 11
  31. Good 0835022 Updated basic auth prompt to reflect app name

    950b8de Fixed password reset for users who use the same email on multiple accounts [Fixes #11102389] Friday, September 2, 11
  32. More Good 3224fff Added an extra 10s while sleeping after

    a Twitter rate-limit error * Twitter isn't always ready immediately after sleeping the advertised amount of time. Friday, September 2, 11
  33. More Good 3224fff Added an extra 10s while sleeping after

    a Twitter rate-limit error * Twitter isn't always ready immediately after sleeping the advertised amount of time. 334a2c4 Fixed bug related to contact syncing [#9190663] Contacts that should have been tagged both friend and follower were having those tags toggled on each #profile_sync run. If the contact had "follower", and profile_sync was run, then the code would set the system_tags to ["following"], blowing away the "follower" tag. It would do the same thing vice versa for the "following" system tag. Friday, September 2, 11
  34. Template Moved all static pages into a generic PagesController [Finishes

    #6375] * Cleaned up the routes * Simplified static page creation Friday, September 2, 11
  35. Template Moved all static pages into a generic PagesController [Finishes

    #6375] * Cleaned up the routes * Simplified static page creation DETAILS SUMMARY Friday, September 2, 11
  36. Template Moved all static pages into a generic PagesController [Finishes

    #6375] * Cleaned up the routes * Simplified static page creation VERB FRAGMENT TICKET # WHY Friday, September 2, 11
  37. Verbs 184 Added 85 Fixed 76 Upped 31 Removed 24

    Switched 21 Improved 20 Updated 16 Renamed Friday, September 2, 11
  38. Friday, September 2, 11

  39. Ryan McGeary ryan.mcgeary.org @rmm5t ryan@mcgeary.org McGeary Consulting Group Friday, September

    2, 11