13. Developing for the GDA

13.1. Commit messages

Start with one short line, preferably less than 50 characters, summarising the changes. Follow this with one empty line, then a more detailed description.

Here is an example:

SUBSYSTEM: Short (50 chars or less) summary of changes

More detailed explanatory text, if necessary.  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.

Write your commit message in the present tense: "Fix bug" and not "Fixed
bug."  This convention matches up with commit messages generated by
commands like git merge and git revert.

Further paragraphs come after blank lines.

- Bullet points are okay, too

- Typically a hyphen or asterisk is used for the bullet, preceded by a
 single space, with blank lines in between, but conventions vary here

- Use a hanging indent

Examples of SUBSYSTEM:

  • CORE - the code that is released on the website
  • DLS - Diamond-specific code
  • CONFIG - configuration

The following links provide advice on writing good commit messages:

Table Of Contents

Previous topic

12. GDA Demo