Committing policies

From Gramps
(Redirected from Committing Policies)
Jump to: navigation, search

Branches

  • Only new features should be committed to the master branch.
  • Only bug fixes should be committed to maintenance branches.
  • The current maintenance branch should be merged regularly into the master branch.

Merging

  • Most changes should be squashed and fast-forwarded.
  • Major new features should be merged no-ff to maintain their development identity.
  • This applies both to pull requests and to work by developers with write permission to the repository.

Pull requests

  • Pull requests must be code-reviewed and tested by a developer.
  • PR authors should not be assumed to be Git experts, so it's up to the Gramps developer doing the merge to ensure that the PR is clean and won’t make a mess of history.
  • The GitHub "Squash and merge" button can be used for most small changes.
  • A no-ff merge outside of GitHub should be used when it is useful to keep the commit history.
  • Bug fixes must be committed to the current stable branch and cherry-picked to master.
  • Only new features should be committed to master directly.

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:

  • 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 bug tracker, the summary shall include the bug ID and summary from the tracker.
  • The summary should be separated from the body of the message by a single blank line.
  • Messages should 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".
  • When committing contributed code, the author should be credited using the --author option.
  • 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 :-(

You can see the last changes with the git log command, an example usage of this command:

git log --oneline

You can also limit the number of entries shown by passing in the -n flag to git. Add --stat to see the files affected by the commit:

git log -5

To credit the contributor of a patch, use:

git commit -m 'Commit message' --author='A U Thor <author@example.com>'

Adding new files

All the files with the translatable strings must be listed in the po/POTFILES.in or po/POTFILES.skip files. This means that most new files must have their names added to these files.

Please remember to do this for new files that you add to Git.

Check

You can make a test on a local copy:

PYTHONPATH=../../gramps python po/test/po_test.py

where ../.. is the path to your local copy

Removing files

Remember to remove references to the file from the po/POTFILES.in and po/POTFILES.skip files.