Proper Commit Messages

Posted by wowus on Stack Overflow See other posts from Stack Overflow or by wowus
Published on 2010-06-10T03:36:24Z Indexed on 2010/06/10 3:42 UTC
Read the original article Hit count: 539

Filed under:

commit

|

source-control

|

commit-message

What are commit messages for? I've always been writing them as an explanation of what I did, but I've recently gotten into a discussion about it with a colleague who writes commit messages explaining why he did. Which one is right, or is there another answer entirely?

© Stack Overflow or respective owner

Related posts about commit

Apache & SVN on Ubuntu - Post-commit hook fails silently, pre-commit hook “Permission Denied”

as seen on Server Fault - Search for 'Server Fault'
I've been struggling for the past couple days to get post-commit email notifications working on my SVN server (running via HTTP with Apache2 on Ubuntu 9.10). SVN commits work fine, but for some reason the hooks are not being properly executed. Here are the configuration settings: - Users access the… >>> More
Apache & SVN on Ubuntu - Post-commit hook fails silently, pre-commit hook "Permission Denied"

as seen on Stack Overflow - Search for 'Stack Overflow'
I've been struggling for the past couple days to get post-commit email notifications working on my SVN server (running via HTTP with Apache2 on Ubuntu 9.10). SVN commits work fine, but for some reason the hooks are not being properly executed. Here are the configuration settings: - Users access the… >>> More
svn branch commit - experimental commit

as seen on Stack Overflow - Search for 'Stack Overflow'
I've made some experimental code that I would like to save in the repository, but I don't want it on the main branch. How would you commit this to a branch? Maybe I got this wrong, but of what I've understood about branching, all you actually do is copying already checked in code to another directory… >>> More
Change commit author at one specific commit

as seen on Stack Overflow - Search for 'Stack Overflow'
I want change author at one specific commit in history. It's not last commit. I know about this question - How do I change the author of a commit in git? But I thinking about something, where I identify commit by hash or short-hash. >>> More
svn commit is hung at start of commit

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm commiting a large changeset, including a large binary file (180 MB) over a slow VPN connection. It looks for all the world like it is stalled. How can I diagnose where it is stuck? The output is: $ svn commit -m "My commit message" Connecting to deprecated signal QDBusConnectionInterface::serviceOwnerChanged(QString… >>> More

Related posts about source-control

Getting a Database into Source Control

as seen on Simple Talk - Search for 'Simple Talk'
For any number of reasons, from simple auditing, to change tracking, to automated deployment, to integration with application development processes, you’re going to want to place your database into source control. Using Red Gate SQL Source Control this process is extremely simple. SQL Source Control… >>> More
Stairway to Database Source Control Level 2: Getting a Database into Source Control

as seen on SQL Server Central - Search for 'SQL Server Central'
In this level, we're going to continue the philosophy of learning by example, and get a database into our SVN repository. We will also consider our overall approach to source control for databases, and the manner in which our team will develop these databases, concurrently. 24%… >>> More
Webinar: SQL Source Control 3.0 Connect your existing source control system to SQL Server

as seen on SQL Server Central - Search for 'SQL Server Central'
Find out what SQL Source Control & SQL Compare can do for your database development and deployment processes at one of our free weekly webinars. Each webinar includes a 30 minute software demonstration and a Q&A session. The Future of SQL Server Monitoring "Being… >>> More
Putting a versioned-but-not-via-source control project in source control

as seen on Stack Overflow - Search for 'Stack Overflow'
I have some old code (an old but still maintained VB6 application) that from a source control point of view is the ultimate example of the plumber's plumbing (or cobbler's shoes). It's been version controlled by the approach of making a new directory for each version. Are there any major downsides… >>> More
SQL Server devs–what source control system do you use, if any? (answer and maybe win free stuff)

as seen on SQL Blog - Search for 'SQL Blog'
Recently I noticed a tweet from notable SQL Server author and community dude-at-large Steve Jones in which he asked how many SQL Server developers were putting their SQL Server source code (i.e. DDL) under source control (I’m paraphrasing because I can’t remember the exact tweet and Twitter’s search… >>> More