Versions Compared

Key

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

...

Tip
titleHow to create a Jira issue
  1. Create an account here, if you do not have one
  2. Login
    1. (optional if you are sure it's new) Search if an issue for what you are after already exists by using the "Find issues"
    2. (optional if you are sure it's new) If an issue on the subject already exists you can add a comment on it
  3. If a issue does not exist, create a new one selecting the "create new issue" command. For details on the issue creation see here
  4. Select the OFBiz project and the issue type.
  5. Fill in all fields, give as many detail you think necessary
    • Generally it is very important to select in the "Affect version" field the OFBiz version you are running.
    • Use the Environment field to specify at least your operating system and the database , your OFBiz implementation is using, since these information could be very useful to help people to work on the issue. If you are using the trunk branch for your development then the SVN revision GIT commit ID should also be specified in the Environment field.
    • Select the concerned component(s). If all components are affected select ALL_COMPONENTS (uncommon case)
    • Leave the "Fix Version/s" field empty, unless you are adding something new (Improvement or New Feature) then "Upcoming Release" is fine. This field will be used by committers to specify the future release that will contain the fix.

  6. If you need to attach files such as patches you must do it as a second step after the issue creation. It is also possible to easily attach screenshots to the issue see here
    • When attaching files or screenshots you can add a comment where you explain how the attached file is supposed to be used. Please reference the file name in the comment because more files could be attached to the issue at a later time and they will be all listed together far away from their comments. If, for any reason, you don't want your patch or attachment to be granted to the ASF or committed, please note it in one related comment (possible cases: not ready yet, examples, etc.)
    • Also please use preferably .patch as extension for patches. When updating an attached file keep the same name : Jira is able to deal with that and will simply gray old files, you don't need to delete them (sometimes its useful to compare older patches versions)
    • If you provide a patch, be sure to use the button "Provide Patch" (the status will then change to "Patch Available"). This allows us (committers, and other contributors) to know that this issue is ready for review.
  7. Jira offers a voting mechanism that is used to give more relevance to the issues (see here to learn more).

...

  • Command line (see the howto below)
  • Eclipse internal command (don't use finish but rather select project to avoid the 2 1st lines in the patch)
  • A tool like TortoiseGit-UI client, like SourceTree, Tortoise, etc.
  • If you use Git to create you patch please use "git diff --no-prefix" option to create it.

...

Warning
titleTrailing white spaces

Please adjust your IDE or similar to not remove trailing white spaces when you create a patch, especially a big one, you may do that temporarily. Consider that else reviewers have to be confronted with a lot of false changes, thanks!

 

...



We prefer that you build your patch from the root as it's easier for committers to merge your change. So please make your patch files from the OFBIZ_HOME directory (usually ofbiz/) and with relative file paths.
"Relative file paths" means the in your patch file names should look like these :
applications/party/widget/partymgr/PartyScreens.xml
framework/webtools/config/WebtoolsErrorUiLabels.properties
and should not have file names like: C:\myfiles\ofbiz\applications\party\widget\partymgr\PartyScreens.xml

...