commit message style
Martin Pool
mbp at canonical.com
Fri Sep 8 01:12:50 BST 2006
I just noticed while looking at Robert's sexy revision number output
that some of the commit messages are very wide.
I think we should try to write them in the same basic style as Python
docstrings, i.e.:
- Less than 80 columns.
- First line should be a self-contained summary in one sentence or
phrase.
- One blank line following the summary.
- The rest can use simple bullet points if you want (or any subset of
ReST).
I think we all recognize how this helps in code; it can make our history
look good too -- and we want bzr's history to set a good example.
You can write these easily in a commit editor or by preparing a message
as you work, or with a multi-line quoted string in bash or zsh, or in
dvcs, or in the emacs command-line editor. The only issue is that you
apparently cannot write a multi-line commit message in vim. That's not
really an excuse though. :-) Just write a message file first. (Or
perhaps we should write a tiny macro to prompt for a message and
commit.)
--
Martin
More information about the bazaar
mailing list