Coding Standard

Commit Message

The commit message should start with a single line that is no more than 62 characters long and that describes the changeset concisely (similar to the subject in an email), followed by a blank line, followed by a more detailed explanation with lines less than 75 characters long.

The first line should not end with a period ("."). If there is only one line in the commit message it can be up to 75 characters long.

The more detailed explanation should include your motivation for the change and contrast its implementation with previous behavior. You should also use the imperative present tense in these messages. In other words, use commands. Instead of ‘I added tests for’ or ‘Adding tests for,’ use ‘Add tests for’.

If there is a jira issue related to the change you should include the issue identifier either in the subject of the commit message or in the body. A full link to the jira issue in the body is encouraged.

See chapter 5 in the ProGit book (Commit Guidelines) and Documentation/SubmittingPatches in the git source code repository.

The format of the commit message will be checked when committing a change to git.

Whitespace

• Indent with tabs, not spaces
• no trailing whitespace
• tab size is 4 characters

Again, whitespace rules will be checked when committing a change to git.

Palaso Coding Standards

Although FieldWorks is not itself a Palaso project, we frequently work with Palaso code. Here is a link to the Palaso coding standards.