Versions Compared

Key

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

...

Issue TypeDefinition and when to use this type
BugA bug is generally a problem with code or data which is not functioning correctly.
ImprovementAn 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?)

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

 

The proposal seems inline with the existing text regarding creating Jira

Info
This following text comes 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

 

 

TaskA 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....)
TestA Test is a unit test or integrated test
WishA 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:

Proposal :

  • To stop using sub tasks for JIRA issues
  • Reasoning
    • they add to too much detail to a tasks and if an issue is that complicated that it needs sub-tasks then it may be cleaner and easier for it to be a separate JIRA issue.
    • that the JIRA sprints don't include sub tasks as part of work delivered, so gives a distorted view of actual work performed.

Summary

This is a brief title for the issue. It summarises what the issue is about.

Examples

Create a separate SVN repository for OFBiz official plugins

Add the auto-entity CRUD services for Runtimedata




Description

The issue description is the most important part of the JIRA issue as it provides information that will allow someone else to investigate and resolve it. It must be written in such a way that it is clear enough for someone to easily replicate the problem. This means that you need to include information about:

...

In some case you might already have an idea about what the issue is and if so then please include your suggestions as to the cause as this may be helpful to the person picking up the issue.

Issue Description Example:Examples:

Implementation of Specific Functiona

This issue is related to the discussion found in this thread in which the community approved restructuring our repositories. To achieve this task the following needs to be done (in this order)

  1. Update the gradle scripts to assume that no plugins exist in the plugins directory by default and no component-load.xml exists. It should follow the same logic in loading the components as found in the ComponentContainer class. Also the activation and deactivation of plugins happens in ofbiz-component.xml, not in component-load.xml
  2. Add a new task to gradle called pullPluginSource that retrieves a plugin from subversion and defaults to the official plugins repository of Apache OFBiz. This task mostly server "Trunk" because it always needs the latest source code of the plugins.
  3. delete plugins/component-load.xml
  4. move all plugins to a new repository called http://svn.apache.org/repos/asf/ofbiz/ofbiz-plugins
  5. move the core framework to a new repository called http://svn.apache.org/repos/asf/ofbiz/ofbiz-framework
  6. fix buildbot to point to the new framework location
  7. update documentation where applicable including README.md



Priority

All JIRA issues need a priority as it determines what needs to be worked on. This is important because it helps to ensure that the community is focussed and working on the right tasks.

...