[livesupport-dev] guidelines for commenting svn commits
  • as we have this wonderful feature in Trac, that it can link issues with
    subversion commit comments, I suggest we use the following guidelines
    for formatting our subversion & Trac ticket comments:


    subversion comments:

    in each commit comment, please place a reference to the issue in Trac
    that the commit is related to. by simply prefixing the issue number with
    the hash-mark "#" character, Trac will automatically create a link to
    the ticket.

    for example:


    this commit fixes isse #31321



    Trac ticket (closing) comments:

    when closing a ticket in Trac, or just when a commit has been made that
    is relevant to a ticket, please place a note into the ticket about the
    relevant changeset. the changeset number you see after issuing the
    subversion commit command. Trac will automatically put a link to the
    changeset in its source browser if you put the changeset number between
    square brackets '[' and ']'.

    for example:


    the issues is solved by changeset [43432]


    for more information, see the "Trac links" section of the Trac
    WikiFormatting page:

    http://code.campware.org/projects/livesupport/wiki/WikiFormatting


    Akos

    PS:

    in the future, we might use a feature for automatically adding comments
    and closing ticket in Trac, based on svn commits, and the comments put
    into commits. for example, an svn comment of the form:


    this closes #21312

    would close ticket #21312 automatically, putting appropriate comments
    into the ticket as well. a comment of the form:

    this references #21312

    would just put a note to issue #21312 about the changeset. for more
    info, see:

    http://projects.edgewall.com/trac/browser/trunk/contrib/trac-post-commit-hook