-
Notifications
You must be signed in to change notification settings - Fork 65
Commit Style Guide
Ian-Stewart-Binks edited this page Jan 3, 2015
·
9 revisions
All commit messages should be of the form:
Branch: Short Description.
Optional Long Description.
Fixes #xxx
Closes #yyy
Ref #zzz
If using the terminal to commit:
git commit -m"Example commit message"
works, but makes it more difficult to
write the optional description.
Use git commit
to bring up an editor in the terminal to facilitate writing
longer commit messages.
Example:
Let Issue-12345
be the branch that is being committed to.
Issue-12345: A brief description of what was changed.
The optional long description should be used to inform future developers of
any extra information. For example, known issues and bugs that pertain to the
changes of the commit would be good to put here. Any bugs or unknown issues
that future developers come across and are not in commit messages should be
reported in the project's issues.
Also, commit messages should follow the 80 character line limit rule.