THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
| Issue Type | Definition and when to use this type |
|---|---|
| Bug | A bug is generally a problem with code or data which is not functioning correctly. |
| Improvement | An improvement is something that enhances the functionality of an existing feature |
| New Feature | New functionality that does not already exist (What is the difference between this and Wish? Proprosal: Proposal: All potential improvements could start as a Wish. When they have been discussed / reviewed by the community then they can be changed to be an approved New Feature) Note: From our existing pages re Jira : If you don't have a patch, and you have want to suggest an enhancement or new feature, then discuss this in the dev mailing list instead of creating a Jira issue; at the end of the discussion, the community will consider if a summary of the thread should be saved in a new Jira issue, to facilitate future development |
| Task | A Task is an action that needs to be carried out that does not fall under any of the other issue types. (NOTE: We have used Tasks in the past - maybe need to specify more clearly when to use....) |
| Test | A Test is a unit test or integrated test |
| Wish | A Wish is a requirement for new something that does not already exist (What's the difference between this and New Feature? Proposal: All potential improvements could start as a Wish. When they have been discussed / reviewed by the community then they can be changed to be an approved New Feature). |
| Sub Task | This task is a child of another JIRA |
...
- If you want general OFBiz help or advice
- If you want to know which version to use
- If you want to talk about anything related to your specific OFBiz implementation
- If you want to know how other users manage a process or function
- If the issue has already been reported and exists in the current list of issues
Instead please post your question or comments on our user or development mailing lists and someone from our community will respond to you.
Many people use OFBiz so there is a chance that issue you have encountered may have already been reported. You can search JIRA using the keyword search to see if anything with a similar topic has been created. There is a 'Search' box in the top right of the main JIRA screen and this searches across all ASF projects. All OFBiz issues have the format 'OFBIZ-9999'
Another way to search issues is by clicking the 'Issues' link on the left hand column and then 'All Issues'. An advanced search query filter box is displayed that allows the user to enter their search criteria. The query box is user friendly and offers interactive lookup on the query commands as you type. See below for an example of a query to find all issues that have the word 'accounts' in their description
| Code Block |
|---|
project = OFBIZ and description ~accounts |
When to Create a Jira Issue
Reminder: Before creating a JIRA issue, please check that it has not already been reported.
If you have identified an issue and also fixed it, and want to contribute the fix back to the project then you can create an issue and attach your patch to it. (Note if the issue has already been created then attach your patch to the existing issue and do not create a jira)
When to create a Jira issue
...
- What you did (including detailed steps to reproduce)
- What you expected to happen
- What actually happened (including exact quotes of error messages, etc)
- If possible provide an URL
...
- reported and exists in the current list of issues
- If you have an idea for a new feature or improvement
- If you don't have a patch, and you want to suggest an enhancement or new feature, then discuss this in the dev mailing list instead of creating a Jira issue; at the end of the discussion, the community will consider if a summary of the thread should be saved in a new Jira issue, to facilitate future development
- If you don't have a patch, but you are planning to work on it, and you want to share your design details with the community, you should discuss this in the mailing list instead of creating a Jira issue
Instead please post your question or comments on our user or development mailing lists and someone from our community will respond to you.
Many people use OFBiz so there is a chance that issue you have encountered may have already been reported. You can search JIRA using the keyword search to see if anything with a similar topic has been created. There is a 'Search' box in the top right of the main JIRA screen and this searches across all ASF projects. All OFBiz issues have the format 'OFBIZ-9999'
Another way to search issues is by clicking the 'Issues' link on the left hand column and then 'All Issues'. An advanced search query filter box is displayed that allows the user to enter their search criteria. The query box is user friendly and offers interactive lookup on the query commands as you type. See below for an example of a query to find all issues that have the word 'accounts' in their description
| Code Block |
|---|
project = OFBIZ and description ~accounts |
When to Create a Jira Issue
Reminder: Before creating a JIRA issue, please check that it has not already been reported.
- If you have identified an issue and also fixed it, and want to contribute the fix back to the project then you can create an issue and attach your patch to it. (Note if the issue has already been created then attach your patch to the existing issue and do not create a jira)
- If you have discovered a bug that has not yet been reported
- If after a community mailing list discussion the recommendation is the create a JIra (e.g. new features, improvements etc)
Discussion Point :
if, on the other hand, you don't have time to do this, you have already decided that you want to implement your patch following your design notes, and you just want to let the community know about the upcoming patch, you can create a Jira issue (to which you will attach your patch when it is ready
Doing this means that patches for improvements and new features can get uploaded to JIRA and the community has not discussed or agreed they want them or are necessary
Are we trying to use JIRA like a patch code repository too? If so then is JIRA the best place to do it? How do we make the distinction between patches that are contributed and are accepted to the repository and those that are not acceptable due to whatever reasons (coding, design etc)
- Summarizing:
- Bugs: always create a new Jira issue everytime you find a new bug
- New features/enhancements: create new Jira issue only if you have a patch (or if you plan to submit it very soon)
...
- Create an account here, if you do not have one
- Login
- (optional if you are sure it's new) Search if an issue for what you are after already exists by using the "Find issues"
- (optional if you are sure it's new) If an issue on the subject already exists you can add a comment on it
- If a issue does not exist, create a new one selecting the "create new issue" command. For details on the issue creation see here
- Select the OFBiz project and the issue type.
- 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. If you are running the trunk then the SVN revision should also be specifyed in the Environment field
- Use the Environment field to specify at least your operating system and the database ofbiz is using since these information could be very useful to help people to work on the issue
- Select the concerned component(s). If all components are affected select ALL_COMPONENTS (uncommon case)
- 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 togheter far 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 usefull to compare older patches versions)
- If you provide a patch, be sure to use the button "Provide Patch" (the status will then be "Patch Available"). This allows us (commiters) to know that this issue is ready for review.
- Jira offers a voting mechanism that is used to give more relevance to the issues (see here to learn more)
...
- new one selecting the "create new issue" command. For details on the issue creation see here
- Select the OFBiz project and the issue type.
- 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. If you are running the trunk then the SVN revision should also be specifyed in the Environment field
- Use the Environment field to specify at least your operating system and the database ofbiz is using since these information could be very useful to help people to work on the issue
- Select the concerned component(s). If all components are affected select ALL_COMPONENTS (uncommon case)
- 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 togheter far 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 usefull to compare older patches versions)
- If you provide a patch, be sure to use the button "Provide Patch" (the status will then be "Patch Available"). This allows us (commiters) to know that this issue is ready for review.
- Jira offers a voting mechanism that is used to give more relevance to the issues (see here to learn more)
If you don't have a patch, and you have discovered a bug, create a Jira issue (if there is not one already) providing as much details as possible (including the rev. number and the environment you are using, and the step to recreate the bug). if you have no ideas how to describe the bug use this template
- What you did (including detailed steps to reproduce)
- What you expected to happen
- What actually happened (including exact quotes of error messages, etc)
- If possible provide an URL
Commenting on a JIRA Issue
...