[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

RE: Commit log messages: Best practices?

From: Nilesh Nimkar <nnimkar_at_amaranthllc.com>
Date: 2005-05-04 02:26:31 CEST

The paths and add delete actions are taken care of by the default svn
mail hook script. It is recommended to set it up. As far as log messages
go, you should describe exactly what changes did u do in that revision.
If that revision is a commit after a merge, it's a good idea to copy and
paste the merge command in the log.

--Nilesh

-----Original Message-----
From: Ben Jackson [mailto:ben@incomumdesign.com]
Sent: Tuesday, May 03, 2005 8:21 PM
To: users@subversion.tigris.org
Subject: Commit log messages: Best practices?

Hi all,

I was wondering if anyone has any tips for best practices in composing
commit messages. Should we require that authors note their name with
commits, or is that a job for svnlook? How specific should you be about
file paths, adds, removes, etc? I thought about something like the
following:

svn ci -m "[joeblow] Added project2/ to /svn/projects"
svn ci -m "[janeblow] Updated menu functionality in
/svn/projects/project1/menu.js"
svn ci -m "[johnblow] First version of template complete in
/svn/projects/project1"

Any suggestions will be welcome. Thanks,

Ben

--
Ben Jackson
Diretor de Desenvolvimento
INCOMUM Design & Conceito

+55 (21) 9997-0593
ben@incomumdesign.com
http://www.incomumdesign.com

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@subversion.tigris.org
For additional commands, e-mail: users-help@subversion.tigris.org

CONFIDENTIALITY AND SECURITY NOTICE:
This e-mail, including any attachments, may contain confidential and proprietary information and may be legally privileged or otherwise protected by law. It may be read and used solely by the intended recipient(s), and any review, use or distribution by others is strictly prohibited. If you are not an intended recipient, please notify us immediately by replying to the sender and delete this e-mail, including any attachments, from your system immediately without reading, copying or distributing them. Thank you for your cooperation.
Amaranth and its affiliates retain all proprietary rights they may have in the information. We cannot give any assurances that this e-mail or any attachments are free of viruses or other harmful code. We reserve the right to monitor, intercept and block all communications involving our computer systems..

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@subversion.tigris.org
For additional commands, e-mail: users-help@subversion.tigris.org
Received on Wed May 4 02:28:15 2005

This is an archived mail posted to the Subversion Users mailing list.