Page History

Aria commit message guidelines

Summary

1. The Subject should begin with the issue related to this commit (‘ARIA-XXXX’)

2. Try to limit your subject to 50 characters, but definitely don’t go over 72

3. Start the subject line (after the issue tag) with a capital letter

4. Don’t end the subject line with a period

5. Use the imperative mood in the subject line (In the body it is optional)

6. Separate the body from the subject with a blank line

7. Wrap the body at 72 characters per line

8. Explain why and what changed, not how

Now, here are some details:

Subject:

1. The Subject should begin with the issue related to this commit.

...

• If applied, this commit will <your subject line here>

Body

1. Separate the body from the subject with a blank line.

...

You should explain what changed, and why did it change. Just focus on making clear the reasons why you made the change in the first place—the way things worked before the change (and what was wrong with that), the way they work now, and why you decided to solve it the way you did. The code, with the help of the diff and source comments, should explain how it was changed.

Metadata

The metadata should contain issue tracker info and related stuff. It should be at the bottom of the body, separated from the previous paragraph of the body (if any) with a black line.

The contents of this section are TBD.

(See long version here)

General Recommendation

Please don’t use `git commit -m` to create your commit message, as chances are it will be harder for you to follow these guidelines in this way.

Sample Commit Message

Sources

http://chris.beams.io/posts/git-commit/

...