Committing policies

From Gramps
Revision as of 03:33, 10 March 2008 by Pez4brian (talk | contribs) (Change from using ChangeLog files to Subversion log messages.)
Jump to: navigation, search

Adding New Files

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

All the files that need to be released must be listed in the in the same directory. Please remember to do this for new files that you add to SVN.

You'll also need to set several properties for new files. For .py files, try the following:

svn propset svn:mime-type text/plain src/
svn propset svn:eol-style native src/
svn propset svn:keywords 'Id' src/

Bugfixes In Branches

Whenever a bug is fixed in a branch, it should be the committer's responsibility to make sure the fix is also committed to the trunk.

You can do this manually, but you can also create a patch on gramps22 branch and apply it to trunk:

gramps22$  svn diff -r PREV > ~/mypatch.patch
gramps22$  cd ../trunk
trunk$  patch -p0 < ~/mypatch.patch

Then you may have to fix things that could not be applied due to conflicts. The patch program would mark the conflicts with the <<<<<<, ======, and >>>>>> signs. You will then need to commit your changes:

trunk$  ./svnci

More info:

Log Messages

Every commit to Subversion 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:

  • Messages should attempt to describe how the change affects the functionality from the user's perspective.
  • It is not necessary to describe minute details about the change nor the files that are affected because that information is already stored by Subversion.
  • If the commit fixes a bug on the bug tracker, the log message shall include the bug ID and summary from the tracker.
  • When committing contributed code, the log message shall list the contributor's name and email.