Changes

Jump to: navigation, search

Committing policies

597 bytes added, 15:38, 17 June 2017
Log messages
Every commit to Git must be accompanied by a log message. These messages will be generated into a ChangeLog when a release is made and should conform to the following guidelines:
===Summary===* The first line of the commit message should consist of a short summary of the change. * Maximum 70 characters.* If the commit fixes a bug on the [http://bugs.gramps-project.org bug tracker], the summary shall include the bug ID and summary from the tracker.===Description===* The summary description should be separated from the body of the message summary by a single blank line.* Messages should attempt Attempt to describe how the change affects the functionality from the user's perspective.
* Use complete sentences when possible.
* It is not necessary to describe minute details about the change nor the files that are affected because that information is already stored by Git and can be viewed with "git diff".
* If you want to refer to another commit, use the full commit hash. It will automatically be converted into a hyperlink by the GitHub web interface. Note: a 6 hexa digit hash enclosed in brackets WILL NOT WORK with GitHub auto-hyperlinking :-(
===Bug tracker integration===
Special keywords can be used to either link to, or resolve, bug reports. They should be separated from the description by a single blank line.
 
To resolve a bug or bugs use:
 
* Fixes #12345
* Fixed #12345
* Resolves #12345
* Resolved #12345
* Fixes #12345, #67890
* Fixed #12345, #67890
* Resolves #12345, #67890
* Resolved #12345, #67890
 
To link to a bug or bugs use:
 
* Bug #12345
* Issue #12345
* Report #12345
* Bugs #12345, #67890
* Issues #12345, #67890
* Reports #12345, #67890
 
For this to work, either the author or committer will need to be a developer on the Mantis bug tracker. The Git name must match either the Mantis username or real name, or the Git email must match the Mantis email.
 
===Useful commands===
You can see the last changes with the git log command, an example usage of this command:
git log --oneline
To credit the contributor of a patch, use:
git commit -m 'Commit message' --author='A U Thor <[email protected]>'
==Adding new files==

Navigation menu