/rev/8631a0070c7c changeset: 1307:8631a0070c7c user: Martin Geisler <[email protected]> date: Mon Oct 19 16:41:31 2009 +0200 summary: doc: described commit message format
diffstat: doc/development.txt | 18 ++++++++++++++++++ 1 files changed, 18 insertions(+), 0 deletions(-) diffs (28 lines): diff -r 6ac6dde1249f -r 8631a0070c7c doc/development.txt --- a/doc/development.txt Mon Oct 19 16:13:47 2009 +0200 +++ b/doc/development.txt Mon Oct 19 16:41:31 2009 +0200 @@ -76,6 +76,24 @@ the changes into the repository, just as if the changesets had been pulled using ``hg pull``. +Commit Messages +""""""""""""""" + +Please format your commit messages as follows:: + + topic: terse one-line summary (60 characters max) + + After the summary line, you're encouraged to provide a bigger + description of your changes. If your change is small or obvious + from the diff, you can leave this out. + + Please wrap your paragraphs at ~70 characters or so. That ensures + that they are readily readable on a standard terminal. + +The *topic* in the summary line describes which part of the code the +changeset touches. There's no fixed list of topics, but a change to +``viff/X.py`` normally gets the "X" topic. + Revising Changes ---------------- _______________________________________________ viff-commits mailing list [email protected] http://lists.viff.dk/listinfo.cgi/viff-commits-viff.dk
