Versions Compared

Key

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

...

  1. Follow coding conventions. Make sure that your files do not have tabs where they should have spaces.
  2. Install the OFBIZ Subversion client configuration file
  3. 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.
  4. 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.
  5. when When you prepare a patch, do your best to avoid to mix formatting changes with relevant changes (if possible, provide a separate patch containing only formatting changes): in this way the reviewersreviewer's work will be easier
  6. when When you prepare a patch, do not insert in the code comments with author information since your name will be recorded in the commit log (that is the place were we store this kind of information)
  7. Internationalize your code with UI labels.
  8. Start out with small contributions which are easier to review. In the process, get familiar with the project's coding style and "thought process."
  9. Keep patches and contributions easy to review and commit. Even if a lot of code is touched, try to keep things isolated and the intent of the patch(es) clear. Remember that most committers can find 20 minutes here and there, but it is very hard to fit in the 2-4 hour time block required to review and commit a larger patch (especially if it touches ANY lower level or more sensitive or complex artifacts, and this requires more thorough review).
  10. 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 Though it is not necessary this makes contributions more traceable for the licensing through the Apache Software Foundation's licensing requirements.
  11. Get other members of the community to try your patch. Write the dev 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.

If you are planning a larger contribution, please follow the following tips to facilitate both licensing and collaboration. These tips will make it easier for committers to review and incorporate your work, and will overall speed up your development process as you'll be asking the OFBiz team to do a number of small, simple tasks rather than a couple of large tasks that a committer will have to find significant time to review and commit.

  1. sadf

How to Send in Your Contributions

...