Jump to: navigation, search

EclipseLink/Development/Process

< EclipseLink‎ | Development
Revision as of 12:34, 30 October 2007 by Tom.ware.oracle.com (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

EclipseLink Development Process

This page describes the process committers should use for developing and submitting code to EclipseLink.

Code Submission

All code that is checked into the EclipseLink SVN should have gone through the following steps

  1. There is a documented reason for the change
    • For bugs, this means an entry in bugzilla
    • For features this means a Functional Specification that describes the goal for the feature and how it is used and a Design Specification that provides an up to date view of how the feature is designed
  1. Code has been reviewed
    • Code changes should be sent to the eclipselink-dev mailing list in the form of an SVN patch
    • It is the committer's responsibility to ensure that at least one other committer has reviewed the code and agrees it should be committed
    • If there are committers that disagree that the code should be committed, the committers with opposing views should work to come to an agreement and if they do not, ask the EclipseLink Architecture council for guidance
  1. Committed must include regression tests
  2. When the the code review has been completed the code can be committed into SVN. A decriptive comment that references the bugzilla link or the feature name should be included with the check-in
  3. When the code is checked in:
    • For bugs, the bugzilla entry must have the final SVN patch attached to it and a short decription of the fix should be added to bugzilla
    • For features, you must ensure both the functional specification and the design specification reflect the state of the current code

If you want to do a check-in that does not follow this process, send an email to the eclipselink-dev mailing list explicitly saying you are hoping to not follow the process and describing your reasoning. This should only be done in exceptional cases