Commit guidelines

From MapbenderWiki

things to keep in mind when committing a change to SVN. Please stick to these rules, otherwise someone else will have to fix it and might break things. If no one fixes it, the overall quality of the project is decreased.

Contents 1 Before an SVN commit 1.1 SVN keywords 1.2 commit message 2 After an SVN commit 2.1 Trac 2.2 Wiki 3 SVN pre-commit hooks

Before an SVN commit

SVN keywords

Add SVN keywords, if the file is new (If it's not a new file, make sure it has SVN keywords). The $Id$ will be replaced by something meaningful like

$Id: mod_logout.php 2738 2008-08-05 07:59:34Z christoph $

after you've committed the file. In Subclipse, do it like this:

Navigator 
→ right-click the new file 
→ Team 
→ Set Property 
→ Property name: "svn:keywords"; Property Content: "HeadURL Id LastChangedBy LastChangedDate LastChangedRevision"

commit message

Please supply a meaningful message. The best way is just to link to a Trac ticket! Image you fixed bug #121. The just add

bug fix: http://trac.osgeo.org/mapbender/ticket/121

as commit message. Commit all files of a bug fix at once.

After an SVN commit

Trac

• After fixing a bug or completing a new feature, go to the bug tracker and close the corresponding issue.
• Add a link to the changeset in the ticket comment, like http://trac.osgeo.org/mapbender/changeset/2766 (This procedure automatically created a patch. Follow the link and click "Unfied Diff" to download it.)

Read more about using Trac.

Wiki

• write or update the module documentation.
• make sure that each module has a Module maintainer.

SVN pre-commit hooks

Some of the above could be done automatically by an SVN pre-commit hook. Let's discuss how this could be achieved at the discussion site.