Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EclipseLink/Development/Bugs/Guidelines"
(→Priority and Target Version) |
(→Status Whiteboard) |
||
| (12 intermediate revisions by the same user not shown) | |||
| Line 7: | Line 7: | ||
Enhancements are reviewed when they are initially entered, but if not targetted at that time, will only be reviewed when release planning occurs. At that time, any candidates for the upcoming release should be targetted. | Enhancements are reviewed when they are initially entered, but if not targetted at that time, will only be reviewed when release planning occurs. At that time, any candidates for the upcoming release should be targetted. | ||
| − | == Priority and Target | + | == Priority and Target Milestone == |
| − | Bugs will be triaged approximately a weekly basis to set Priority and | + | Bugs will be triaged on approximately a weekly basis to set Priority and Target Milestone. Triaged bugs will have a Target Milestone set at that time. Target milestone will either be a specific version or one of the following: |
| − | + | * "Future" - The goal is to make this the only setting for triaged bugs with no specific target | |
| + | * "1.1x" - this setting deprecated, 1.1x bugs will be retriaged and have a new target and priority set. | ||
| − | + | If the "Target Milestone " is set to "Future" the priority field indicates the bug's priority relative to other bugs with a "Future" target. i.e. P1 bugs will be targetted before P2 bugs, P2 bugs before P3 bugs and so on... | |
| − | + | ||
| − | + | ||
| − | + | ''Note: if Target Milestone is not set, this means the bug has not been triaged and the Priority and Target Milestone have not been set by the team'' | |
| − | If the Target | + | If the Target Milestone is set to a specific version, the following values are used in the priority field |
* P1 - Urgent bug fix. Someone should work on this immediately | * P1 - Urgent bug fix. Someone should work on this immediately | ||
| Line 29: | Line 28: | ||
== Keywords == | == Keywords == | ||
| − | We use the following keywords at this time: | + | There are a predefined set of keywords in bugzilla. We use the following keywords at this time: |
* test - for bugs that are issues with a test (rather than the code the test is exercising) | * test - for bugs that are issues with a test (rather than the code the test is exercising) | ||
| Line 37: | Line 36: | ||
== Status Whiteboard == | == Status Whiteboard == | ||
| − | + | We use the status whiteboard to add additional categorization of bugs for queries. The following strings are used. | |
| + | |||
| + | ''' Bug Analysis ''' | ||
* simple_fix - for issues where the fix is a trivial change, something that can be undertaken in a matter of minutes. Some examples of this kind of bug is a typo in an error message or a comment, a wording issue with an Error message, or an unused import in a single file. | * simple_fix - for issues where the fix is a trivial change, something that can be undertaken in a matter of minutes. Some examples of this kind of bug is a typo in an error message or a comment, a wording issue with an Error message, or an unused import in a single file. | ||
* submitted_patch - indicates that a member of the community has submitted a patch. This allows us to search for these issues and expedite their inclusion in the product. | * submitted_patch - indicates that a member of the community has submitted a patch. This allows us to search for these issues and expedite their inclusion in the product. | ||
| + | * spec - indicates a bug related to spec compliance | ||
| + | |||
| + | ''' Release Themes ''' | ||
| + | |||
| + | The following strings are used to identify bugs that fit into the themes for our various releases. The release number is prepended to a string that identifies the theme. These will be used to make candidates for those releases searchable. | ||
| + | |||
| + | * 2_1_advanced | ||
| + | * 2_1_helios | ||
| + | * 2_1_documentation | ||
| + | * 2_1_community | ||
| + | |||
| + | See http://wiki.eclipse.org/EclipseLink/Development/2.1 for a description of the EclipseLink 2.1 themes | ||
| + | |||
| + | ''' Database Integration Bug Identifiers ''' | ||
| + | |||
| + | The following strings identify bugs that relate to specific database platforms. | ||
| + | |||
| + | * oracle | ||
| + | * mysql | ||
| + | * derby | ||
| + | * postgresql | ||
| + | * timesten | ||
| + | * hsql | ||
| + | * db2 | ||
| + | * db2mainframe | ||
| + | * sybase | ||
| + | * sqlserver | ||
| + | * maxdb | ||
| + | * sqlanywhere | ||
| + | * h2 | ||
| + | * firebird | ||
| + | * informix | ||
| + | * pointbase | ||
| + | * access | ||
| + | * attunity | ||
| + | * cloudscape | ||
| + | |||
| + | ''' Deployment Platform Integration Identifiers ''' | ||
| + | |||
| + | The following strings identify bugs that relate to specific deployment platforms. | ||
| + | |||
| + | * weblogic | ||
| + | * oc4j | ||
| + | * glassfish | ||
| + | * websphere | ||
| + | * netweaver | ||
| + | * jboss | ||
| + | * spring | ||
| + | * tomcat | ||
| + | * osgi | ||
| + | * equinox | ||
| + | * felix | ||
| + | * knopplerfish | ||
| + | |||
| + | ''' Cross Component Feature Identifiers ''' | ||
| + | |||
| + | The following strings indentify bugs that related to features that span more than one component. | ||
| + | |||
| + | * dynamic (Dynamic Persistence Feature) | ||
| + | |||
| + | ''' Functional Categories ''' | ||
| + | The following strings identity bugs that relate to a specific functional category. This allows us to easily group similar bugs. | ||
| + | |||
| + | * jpa_query_enhancements | ||
| + | * table_per_class | ||
| + | * jpql-parser-conflict | ||
== Summary == | == Summary == | ||
The summary field of an issue with the build should be prepended with the string: [Build] | The summary field of an issue with the build should be prepended with the string: [Build] | ||
Latest revision as of 15:49, 26 January 2011
Contents
EclipseLink Bug Report Guidelines
Severity
The Severity field is used as an indication of the filer's impression of the severity of the bug. Except in cases of abuse of this field, it should usually be left as initially set. The exception to this rule is that some bugs are clearly enhancements rather than bugs. They can be changed to Enhancements.
Enhancements are reviewed when they are initially entered, but if not targetted at that time, will only be reviewed when release planning occurs. At that time, any candidates for the upcoming release should be targetted.
Priority and Target Milestone
Bugs will be triaged on approximately a weekly basis to set Priority and Target Milestone. Triaged bugs will have a Target Milestone set at that time. Target milestone will either be a specific version or one of the following:
- "Future" - The goal is to make this the only setting for triaged bugs with no specific target
- "1.1x" - this setting deprecated, 1.1x bugs will be retriaged and have a new target and priority set.
If the "Target Milestone " is set to "Future" the priority field indicates the bug's priority relative to other bugs with a "Future" target. i.e. P1 bugs will be targetted before P2 bugs, P2 bugs before P3 bugs and so on...
Note: if Target Milestone is not set, this means the bug has not been triaged and the Priority and Target Milestone have not been set by the team
If the Target Milestone is set to a specific version, the following values are used in the priority field
- P1 - Urgent bug fix. Someone should work on this immediately
- P2 - Required for Release. This fix is a requirement for the release listed in the target field.
- P3 - This is the default. Targetted for the listed release, but not considered a blocker
- P4 - Nice to have, time permitting
- P5 - Lower priority - likely to be deferred
Keywords
There are a predefined set of keywords in bugzilla. We use the following keywords at this time:
- test - for bugs that are issues with a test (rather than the code the test is exercising)
- performance - for bugs that describe an issue that the key effect is on performance
- contributed - should be added to a bug on any community submitted patch when it is checked in
Status Whiteboard
We use the status whiteboard to add additional categorization of bugs for queries. The following strings are used.
Bug Analysis
- simple_fix - for issues where the fix is a trivial change, something that can be undertaken in a matter of minutes. Some examples of this kind of bug is a typo in an error message or a comment, a wording issue with an Error message, or an unused import in a single file.
- submitted_patch - indicates that a member of the community has submitted a patch. This allows us to search for these issues and expedite their inclusion in the product.
- spec - indicates a bug related to spec compliance
Release Themes
The following strings are used to identify bugs that fit into the themes for our various releases. The release number is prepended to a string that identifies the theme. These will be used to make candidates for those releases searchable.
- 2_1_advanced
- 2_1_helios
- 2_1_documentation
- 2_1_community
See http://wiki.eclipse.org/EclipseLink/Development/2.1 for a description of the EclipseLink 2.1 themes
Database Integration Bug Identifiers
The following strings identify bugs that relate to specific database platforms.
- oracle
- mysql
- derby
- postgresql
- timesten
- hsql
- db2
- db2mainframe
- sybase
- sqlserver
- maxdb
- sqlanywhere
- h2
- firebird
- informix
- pointbase
- access
- attunity
- cloudscape
Deployment Platform Integration Identifiers
The following strings identify bugs that relate to specific deployment platforms.
- weblogic
- oc4j
- glassfish
- websphere
- netweaver
- jboss
- spring
- tomcat
- osgi
- equinox
- felix
- knopplerfish
Cross Component Feature Identifiers
The following strings indentify bugs that related to features that span more than one component.
- dynamic (Dynamic Persistence Feature)
Functional Categories The following strings identity bugs that relate to a specific functional category. This allows us to easily group similar bugs.
- jpa_query_enhancements
- table_per_class
- jpql-parser-conflict
Summary
The summary field of an issue with the build should be prepended with the string: [Build]