You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Contributions

The OpenJPA 2.0 release needs contributions in the areas of development, testing, and documentation. If you are simply interested in trying out new capabilities of JPA 2.0, contributing to the test suite is a great way to do that; while making a significant contribution to the project.

Process

  • All new features, spec related or other improvements must have an corresponding JIRA. Large items should be broken down into manageable sub-tasks. The JIRA should include design details, decision rationality, and testing information.
  • Use test driven development (write tests before code). Test driven development can be extremely beneficial for gaining an initial understanding the requirements of the feature and will help ensure that the feature is adequately tested. Too often, tests are the last thing to be written so they can end up incomplete or worse yet, forgotten. Test driven development in OpenJPA is now more feasible with the recent enhancement in OPENJPA-766.
  • Documentation updates/additions, when necessary, must accompany new function.
  • OpenJPA 2.0 development will be based on three week iterations (or sprints). Each iteration will include a set of new features and enhancements. Features must have accompanying tests and documentation and go through a code review. A feature must fit within the iteration period. Larger and/or complex tasks may need to be broken down such that they can be contributed as individual, consumable features. For example, JPA 2.0 defines relationship support within an embedded. If this task is deemed complex due to the need to support multiple relationship types, relationship type one-to-one could be made available in one iteration and the many-to-one relationship type could be added in subsequent iteration.
  • A call for participation will be posted prior to the start of each iteration. An iteration plan will be composed based on who can participate and what they plan to contribute.
  • Code reviews will be conducted using the standard Commit-Then-Review (CTR) process (for OpenJPA committers), unless a pre-commit code review is specifically requested. Artifacts submitted by non-committers must be reviewed before they are committed.
  • No labels