Page History

...

1. No incomplete features in "Trunk", ever.
   • If you are in-progress on a feature, create an SVN sandbox or DSpace branch area to work on it, and pull it over to Trunk once it has been completed and is ready for testing & release. This will hopefully help us to avoid encountering a situation where we need to revert a large, unfinished patch at the last moment.
   • Modules which do not reside in DSpace "Trunk" (e.g. http://scm.dspace.org/svn/repo/modules/) should also follow this rule. If there is major rework to be done on a module, create a "branch" to do that work and migrate that branch back to the Module's Trunk once it is ready for release.
   • Clarification: Although this rule may seem strict, it is meant to point out that a broken Trunk is an urgent issue. There may be situations where breaking Trunk temporarily may even be necessary. However, we should make all attempts to keep breakage to a minimum (or forewarn the Committer team if anticipated). Temporary breakage is OK, but longer-term breakage (a few days or more) will negatively affect us all.
2. All new features must have documentation before committing to Trunk.
   • New features/improvements should not be committed to Trunk until there is some minimal documentation (minimal documentation includes documenting all configuration options). Ideally, they should also come with usage documentation (i.e. examples of how to use the feature, how to configure the feature, etc.) This will help us all ensure that Documentation is ready by the time we get to the next release, and hopefully lessen the time that any one person has to spend cleaning up or rewriting documentation.