![]() |
![]() |
Coding StandardsASF RequirementsCopyright notices for submitted patchesPlease see http://www.apache.org/legal/src-headers.html for details of the following summary. Apache does not require you to assign ownership or copyright for any patches that you submit via the above process. You retain ownership for all such patches. But Apache does require you to grant Apache a license to use the patch. To do this for new files, do not include a copyright statement in the file but include this license as comments in the header of your source contribution - http://www.apache.org/legal/src-headers.html#headers License and Notice filesPlease see http://www.apache.org/licenses/ for details of the following summary. All release artifacts published by an Apache project (JAR/WAR/EAR, zip, tar, ...) must include License and Notice files. A Disclaimer file must be included for any artifacts included form the incubator. General Formatting ConventionsOpenJPA adheres to Sun's Code Conventions for the Java Programming Language, which is available at http://java.sun.com/docs/codeconv/
Eclipse UsersFormatter ProfileThe profile can be downloaded from here - OpenJPA-formatting-preferences.xml
Code TemplateThe latest version with the required ASL header format can be downloaded here - OpenJPA-code-style-template.xml
Submitting a PatchIf you make changes to OpenJPA, and would like to contribute the to the project, you should create a patch via svn and post it to the OpenJPA JIRA issue tracker. To create a patch, simply execute the following command: $> svn diff > your-changes.patch Note: You may also use Eclipse to create a patch (Team -> Create Patch...), but this may require committers to modify the patch to match their project layout (workspace per branch or all branches in one workspace) and some committers may not be using Eclipse/Subclipse. TestCasesWhen we make a change it's generally a good idea to include a jUnit testcase which demonstrates the desired behavior. Changes that only affect a specific database or only operate in a certain environment (ie DB2 on Z/OS, or only when used with SunOne) are exceptions to the rule. The testcase should be self validating via jUnit asserts. Writing messages to system.err or system.out is discouraged - they lead to the impression that some manual interpretation of the results must be done. Messages like these are useful when developing the tests or when diagnosing problems but should not be committed. |