Page History

...

This document is intended to capture some of the policies we would like all committers to follow when it comes to checking in changes into our SVN tree.

Commit Log Format

Each commit to the repository must have a non-empty log message. The message format should start with a one-line short summary prefixed with the Jira issue number. If you do not have a Jira issue number, create one before you commit. The short summary need not be a complete sentence with proper punctuation and grammar since it is best to keep it to 72 characters or less.

After the short summary line, you may continue the message with one or more paragraphs separated by an empty line. The empty line after the short summary is necessary if you want to add more text since source control tools like git may send the log message as an email and use the first line up to an empty line as the email subject.

Since we support many operating systems, it would be best to list which one the commit was tested on to let the community know what has been covered.

TS-#### short summary (72 chars or less), not a sentence

Tested: Ubuntu-9.0.4,OSX-10.5,FreeBSD-7.2,OpenSolaris-2009.06

More detailed explanatory text as necessary, patch attributions, and
what platforms the commit has been tested on.  Wrap it to about 72
characters or so.  In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body.  The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.

In the future, I'd like to see the need for listing the operating systems tested on go away when we implement a testing environment that can accept pre-commit patch and verify that patch passes a series of smoke tests.

Trunk

Trunk is CTR, Commit-Then-Review, policy. This was discussed and voted on by the community a long time ago. This does grant a lof of freedom to committing experimental or unstable code to the trunk. However, with such powers, comes some responsibilities:

...