viff

changeset 1307:8631a0070c7c

doc: described commit message format
author Martin Geisler <mg@cs.au.dk>
date Mon, 19 Oct 2009 16:41:31 +0200
parents 6ac6dde1249f
children 85fd0fbfdb5a
files doc/development.txt
diffstat 1 files changed, 18 insertions(+), 0 deletions(-) [+]
line diff
     1.1 --- a/doc/development.txt	Mon Oct 19 16:13:47 2009 +0200
     1.2 +++ b/doc/development.txt	Mon Oct 19 16:41:31 2009 +0200
     1.3 @@ -76,6 +76,24 @@
     1.4  the changes into the repository, just as if the changesets had been
     1.5  pulled using ``hg pull``.
     1.6  
     1.7 +Commit Messages
     1.8 +"""""""""""""""
     1.9 +
    1.10 +Please format your commit messages as follows::
    1.11 +
    1.12 +   topic: terse one-line summary (60 characters max)
    1.13 +
    1.14 +   After the summary line, you're encouraged to provide a bigger
    1.15 +   description of your changes. If your change is small or obvious
    1.16 +   from the diff, you can leave this out.
    1.17 +
    1.18 +   Please wrap your paragraphs at ~70 characters or so. That ensures
    1.19 +   that they are readily readable on a standard terminal.
    1.20 +
    1.21 +The *topic* in the summary line describes which part of the code the
    1.22 +changeset touches. There's no fixed list of topics, but a change to
    1.23 +``viff/X.py`` normally gets the "X" topic.
    1.24 +
    1.25  
    1.26  Revising Changes
    1.27  ----------------