Quite an interesting idea, I was thinking... ----- Forwarded message from Isaac <[email protected]> -----
From: Isaac <[email protected]> To: eBox developers list <[email protected]> Date: Tue, 25 Aug 2009 19:10:09 +0100 Subject: [Ebox-devel] Documentation meeting minutes Message-ID: <[email protected]> List-Id: eBox development <ebox-devel.lists.warp.es> X-BeenThere: [email protected] In an effort to ensure that we will always have decent and up-to-date documentation, we have just held a meeting about this issue. These are the decisions taken in the meeting: 1. Documentation is a first-class citizen, and needs to be kept up to date, a release is not tagged until doc is ready. 2. Documentation == English documentation. Spanish doc is 'translation' and, although it should be as up-to-date as possible, it is not required to tag a release. 3. Tags for SVN commit messages We are going to use a tag system to add information to commits to trunk and to maintenance branches that will help us to keep the doc up-to-date and in other tasks too. Only commit messages to trunk and to maintenance branches require and can have a tag. The available tags are: NN - Null tag. If no tag applies, use this one to trick the commit hook (the purpose of this is to avoid people forgetting the existence of tags. If you don't want a tag you have to explicitly say so). BP - Backport. This tag indicates that this fix should be backported. ND - Needs doc. This tag indicates that this commit requires documentation to be created or updated. BT - Breaks test. This tag indicates that this commit breaks an existing ANSTE test. The pre-commit hook just checks that the commit log contains at least one of this tags, or more separated by commas. The post-commit hook will create appropriate tickets for the BP, ND and BT tags. An example would be: ND,BT: Fix the form for new grisbos This would create two tickets about fixing the anste tests and updating the documentation. The tickets will be assigned to the appropriate milestone depending on whether the commit was to trunk or to one of the maintenance branches. The recommendation is to deal with these tickets as soon as possible. ND and BT tickets should probably be taken care of by the committer, while BP tickets should probably be dealt with by the committer and the branch maintainer. In the worst case at least we will be aware of the existence of these problems. The 5 developers in the meeting agreed to this and it will be applied soon. Feel free to comment on it :) Cheers! -- Isaac Clerencia - Developer [email protected] http://people.warp.es/~isaac/blog/ eBox - Managing Computer Networks Was Never This Easy Download eBox at www.ebox-platform.com _______________________________________________ Ebox-devel mailing list [email protected] https://lists.warp.es/mailman/listinfo/ebox-devel ----- End forwarded message ----- -- "To save the world requires faith and courage: faith in reason, and courage to proclaim what reason shows to be true." -- Bertrand Russell _______________________________________________ Mailing list [email protected] Archive, settings, or unsubscribe: https://secure.mysociety.org/admin/lists/mailman/listinfo/developers-public
