DZone
Java Zone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
  • Refcardz
  • Trend Reports
  • Webinars
  • Zones
  • |
    • Agile
    • AI
    • Big Data
    • Cloud
    • Database
    • DevOps
    • Integration
    • IoT
    • Java
    • Microservices
    • Open Source
    • Performance
    • Security
    • Web Dev
DZone > Java Zone > Choose Your Commit Messages Properly

Choose Your Commit Messages Properly

Juri Strumpflohner user avatar by
Juri Strumpflohner
·
Jun. 15, 12 · Java Zone · Interview
Like (0)
Save
Tweet
4.98K Views

Join the DZone community and get the full member experience.

Join For Free
i already wrote a couple of posts about version control stuff and best practices related with it. so today, what about proper commit messages?

how often did you take a look at the history of some file/folder ?? it's just the best backup system you could have and that's one of the main purposes of a vcs (forget about branching, merging etc for a while ). and if you did look at your commit messages, were they meaningful?? did they make any sense to you?? so often they don't, right? messages like...
  • method 'somemethodinaclass' modified
  • production-build
  • added some files
  • fixed some bugs
  • ...
...they just don't say anything, right?? you have to open some kind of comparison editor and directly look at what actually changed .

instead...

when looking at the 1st sample comment "method 'somemethodinaclass' modified", what would you think about this comment as a (more expressive) alternative:

bugfix: changed linq query to return all entities except the current one

now assume you're currently searching for an issue you're having related to the reading of some entities...i bet this message would jump on your eyes immediately!

so..

..the history excerpt from your vcs should nearly be something that you could directly copy and paste as a public version history on your webpage.


Commit (data management)

Published at DZone with permission of Juri Strumpflohner. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • Portfolio Architecture Examples: Retail Collection
  • How to Minimize Software Development Cost
  • Upsert in SQL: What Is an Upsert, and When Should You Use One?
  • A Smarter Redis

Comments

Java Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • MVB Program
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends:

DZone.com is powered by 

AnswerHub logo