Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Overview of Code Approval Process – How to get your Code into DSpace!

1. Make your code available

First, you must make your code available to the DSpace Committers Group for review. This can be in the form of a patch (usually posted to our Issue tracker), or you can provide us with downloadable version or read-only access to your SVN or CVS code repository.

...

Note
titleKeep in Mind the "Feature Freeze" Deadlines

When the next release of DSpace is getting close, the Committers will set a "Feature Freeze" date, after which no new features/code will be accepted for that release. The reason for this is that the Committers need time to stabilize the current code before the next release can be completed. Make sure to check the Next Release Status page for details on when the next "Feature Freeze" is – if you are submitting your code too close to the "Feature Freeze" date, it may unfortunately need to wait until after the next version of DSpace is released. Patches which fix bugs will also generally be considered until much closer to the final release date.

2. Code Review Process

Once the code is made available, the Committers Group will take time to review the work and provide feedback/comments. Usually, one (or more) committers who are interested in this work will contact you and discuss any feedback we have, and whether or not there would need to be some general changes before we could accept it. Some code changes are readily accepted (because they are stable and look good), others may require more work (if there are concerns or issues that Committers notice).

Info
titleCode Review Timeframe

The timeframe of a code review will vary, based on how much time the Committers have. All Committers are volunteers, and only have a small amount of time to provide to the project in a given week. We will make every effort to get back to you with feedback within a few weeks. But, if you haven't heard anything, feel free to ask!

3. Reworking Code (if necessary) & Next Steps

After the code review & feedback, interested Committers may help you to rework the code (if needed). They'll also provide you with next steps on getting the code into DSpace. If it can be accepted immediately, it will be. If not, we'll try to help figure out the best route forward.

Info
titleHow you can help

As our Committers are all volunteers, they don't always have the time to rework code changes for you. If you want your code change accepted in a timely manner, please offer to make the changes yourself (otherwise your patch suggestion by wait in a "holding queue" until someone has enough time to deal with it).

4. Acceptance!

Once your code is accepted, it will be released in the next version of DSpace software!

...