How to Contribute to OFBiz
OFBiz is a community-developed open source project. What that means is that we're looking to you, the user, to help make our application better. Anybody can contribute to OFBiz--you do not have to be a committer, on an "approved" list, or be a friend or relative. All contributions are considered based on their merit for the project. You also do not need commit privileges to make a contribution. Just create a patch file and post it on our JIRA issue tracker. If you become a frequent contributors and are willing to help with the long term development of the project, you could become a project committer.
The following guidelines are meant to help contributors work with the committers and the community as a whole:
- Follow coding conventions. Make sure that your files do not have tabs where they should have spaces.
- Install the OFBIZ Subversion client configuration file
- Discuss your features with the community. What are you trying to implement, and how are you planning to do it? This is especially important if you are new to the project.
- Write clear, well-commented and understandable code. Don't take shortcuts, especially around variable names and error or warning messages. Use understandable data structures. Remember, somebody else will be working with your code down the road.
- Internationalize your code with UI labels.
- Start out with small contributions which are easier to review. In the process, get familiar with the project's coding style and "thought process."
- Put your contributions on JIRA instead of emailing it directly to the committers, so everybody can review and comment on it. This is also required for compliance with the Apache Software Foundation's licensing requirements.
- Get other members of the community to try your patch. Write the users list and tell them what you've done and ask them to try it out and vote for it. This would help the committers when they are reviewing your patches.
How to Send in Your Contributions
The first step is to create an account for yourself on the JIRA issue tracker and then create a new issue. Describe the contribution that you are making: are you fixing a bug, improving an existing feature, or creating a new feature? Please write as detailed a description as you can and attach screenshots if possible of what you've done. OFBIZ is a huge project, and what may be obvious to you might not be to someone else, even a committer who is familiar with the project.
Then, send in a patch file. This is a file which will describe all the differences between your modified code and the code in the OFBiz Subversion repository. You can create a patch file by using a command like this:
$ svn diff applications/product > product.diff
will give us a patch file for all your changes in the applications/product sub-directory and save it as product.diff.
If you have added new files, then use the "add" command first, then make the diff
$ svn add applications/product/<my-file>
$ svn diff applications/product > product.diff
You can also specify the exact files that you'd wish to include in your patch file, in case there are files that you have modified but do not wish to submit. For example, you can use
$ svn status applications/product
to see which files have been modified (they start with an "M") or added (which start with a "?").
Then do
$ svn diff applications/product/entity/ applications/product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml > product-shipment.diff
if you only want to make a patch file of the entity/ sub-directory and the ShipmentServices.xml file.
For consistency, please make your patch files from the ofbiz/ directory.
Next upload your patch file to your JIRA issue.
Finally, if there are several patch files already on an issue, please write a comment about which file should be used.