Difference between revisions of "BMO/UserGuide/BugFields"

From MozillaWiki
< BMO‎ | UserGuide
Jump to: navigation, search
 
(34 intermediate revisions by 12 users not shown)
Line 1: Line 1:
 
== Bugzilla Field Descriptions ==
 
== Bugzilla Field Descriptions ==
  
{{anchor|percentage_complete}}
 
; %Complete
 
: How close to 100% done this bug is, by comparing its Hours Worked to its Orig. Est..
 
 
{{anchor|alias}}
 
{{anchor|alias}}
 
; Alias
 
; Alias
Line 37: Line 34:
 
; Creation date
 
; Creation date
 
: When the bug was filed.
 
: When the bug was filed.
{{anchor|current_estimate}}
+
{{anchor|dependson}}
; Current Estimate
 
: Amount of actual time worked added to the remaining time left is the current time estimate.
 
{{anchor|deadline}}
 
; Deadline
 
: The date that this bug must be resolved by, entered in YYYY-MM-DD format.
 
{{anchor|depends_on}}
 
 
; Depends on
 
; Depends on
 
: The bugs listed here must be resolved before this bug can be resolved.
 
: The bugs listed here must be resolved before this bug can be resolved.
Line 49: Line 40:
 
; Duplicates
 
; Duplicates
 
: List of bugs that have been marked a duplicate of the bug currently being viewed.
 
: List of bugs that have been marked a duplicate of the bug currently being viewed.
{{anchor|gain}}
 
; Gain
 
: Amount of work time that has been gained on the bug.
 
{{anchor|rep_platform}}
 
; Hardware
 
: This is the hardware platform against which the bug was reported.
 
{{anchor|remaining_time}}
 
; Hours Left
 
:The number of hours of work left on this bug, calculated by subtracting the Hours Worked from the Orig. Est..
 
{{anchor|work_time}}
 
; Hours Worked
 
: The total amount of time spent on this bug so far.
 
{{anchor|importance}}
 
; Importance
 
: The importance of a bug is described as the combination of its Priority and Severity.
 
 
{{anchor|keywords}}
 
{{anchor|keywords}}
 
; Keywords
 
; Keywords
: You can add keywords from a defined list to bugs, in order to easily identify and group them.
+
: Keywords are a controlled vocabulary for characterizing bugs across Products and Components. Examples of this field are <code>regression</code>, <code>sec-high</code>, and <code>topcrash</code>. Bugzilla administrators manage [https://bugzilla.mozilla.org/describekeywords.cgi the list of keywords]. If you believe you need a new keyword, [https://bugzilla.mozilla.org/enter_bug.cgi?product=bugzilla.mozilla.org&component=Administration please contact the administrators to discuss].
 
{{anchor|bug_mentor}}
 
{{anchor|bug_mentor}}
 
; Mentors
 
; Mentors
Line 73: Line 49:
 
; Needinfo
 
; Needinfo
 
: More information has been requested from specific individuals, or anyone, to move the bug forward to completion.
 
: More information has been requested from specific individuals, or anyone, to move the bug forward to completion.
{{anchor|estimated_time}}
 
; Orig. Est.
 
: The amount of time that has been estimated it will take to resolve this bug.
 
 
{{anchor|op_sys}}
 
{{anchor|op_sys}}
 
; OS
 
; OS
: This is the operating system against which the bug was reported.=
+
: This is the operating system against which the bug was reported.
 +
{{anchor|rep_platform}}
 +
; Platform
 +
: This is the hardware platform against which the bug was reported (ARM, ARM64, x86, x86_64, etc).
 
{{anchor|priority}}
 
{{anchor|priority}}
 
; Priority
 
; Priority
: This field describes the importance and order in which a bug should be fixed compared to other bugs. This field is utilized by the programmers/engineers to prioritize their work to be done where P1 is considered the highest and P5 is the lowest.
+
{| class="wikitable"
 +
|-
 +
! Priority !! Description
 +
|-
 +
| '''--''' || No decision
 +
|-
 +
| '''P1''' || Fix in the current release cycle
 +
|-
 +
| '''P2''' || Fix in the next release cycle or the following (nightly + 1 or nightly + 2)
 +
|-
 +
| '''P3''' || Backlog
 +
|-
 +
| '''P4''' || Do not use. This priority is for the Web Platform Test bot.
 +
|-
 +
| '''P5''' || Will not fix, but will accept a patch
 +
|}
 +
 
 +
: This field describes the importance and order in which a bug should be fixed compared to other bugs. This field is utilized by the programmers/engineers/release managers/managers to prioritize the work to be done. See the Firefox [https://firefox-source-docs.mozilla.org/bug-mgmt/policies/triage-bugzilla.html triage documentation] and [https://firefox-source-docs.mozilla.org/bug-mgmt/guides/priority.html priority definitions], or for the main Bugzilla project, [[Bugzilla:Priority_System]].
 
{{anchor|product}}
 
{{anchor|product}}
 
; Product
 
; Product
Line 88: Line 81:
 
; QA Contact
 
; QA Contact
 
: The person responsible for confirming this bug if it is unconfirmed, and for verifying the fix once the bug has been resolved.
 
: The person responsible for confirming this bug if it is unconfirmed, and for verifying the fix once the bug has been resolved.
 +
{{anchor|rank}}
 +
; Rank
 +
: Used by some groups to provide finer-grained ordering for working on bugs than afforded by the Priority field. Use of this field is restricted to the `rank-setters` group.
 +
{{anchor|regressed_by}}
 +
; Regressed by
 +
: This bug has been introduced by the bugs listed here.
 +
{{anchor|regresses}}
 +
; Regressions
 +
: This bug has introduced the bugs listed here.
 
{{anchor|reporter}}
 
{{anchor|reporter}}
 
; Reporter
 
; Reporter
Line 93: Line 95:
 
{{anchor|see_also}}
 
{{anchor|see_also}}
 
; See Also
 
; See Also
: This allows you to refer to bugs in other installations. You can enter a URL to a bug in the 'Add Bug URLs' field to note that that bug is related to this one. You can enter multiple URLs at once by separating them with a comma. You should normally use this field to refer to bugs in other installations. For bugs in this installation, it is better to use the Depends on and Blocks fields.
+
: This allows you to refer to bugs in other bug tracker installations. You can enter a URL to a bug in the 'Add Bug URLs' field to note that that bug is related to this one. You can enter multiple URLs at once by separating them with a comma. You should normally use this field to refer to bugs in other bug tracker installations, or bugs which are related to, but not known to be duplicates of the bug. Bugs which are regressions should be listed in the Regressed by field (above)
 
{{anchor|bug_severity}}
 
{{anchor|bug_severity}}
 
; Severity
 
; Severity
: This field describes the impact of a bug.
+
: This field describes the impact of a bug. This field is utilized by the programmers/engineers/release managers/managers to determine the severity of issues and used as input for the priority of the bug. It should not be set by people filing bugs. See the Firefox [https://firefox-source-docs.mozilla.org/bug-mgmt/policies/triage-bugzilla.html triage documentation] and [https://firefox-source-docs.mozilla.org/bug-mgmt/guides/severity.html severity documentation].
 
{| class="wikitable"
 
{| class="wikitable"
|'''blocker'''
 
|Blocks development and/or testing work
 
 
  |-
 
  |-
  |'''critical'''
+
  ! Severity !! Description
|Crashes, loss of data, severe memory leak
 
 
  |-
 
  |-
  |'''major'''
+
  |'''--'''
  |Major loss of function
+
  |Default value for new bugs; bug triagers for components (ie engineers and other core project folks) are expected to update the bug's severity from this value. To avoid them missing new bugs for triage, do not alter this default when filing bugs.
 +
|-
 +
|'''S1'''
 +
|(Catastrophic) Blocks development/testing, may impact more than 25% of users, causes data loss, likely dot release driver, and no workaround available
 
  |-
 
  |-
  |'''normal'''
+
  |'''S2'''
  |Regular issue, some loss of functionality under specific circumstances
+
  |(Serious) Major functionality/product severely impaired or a high impact issue and a satisfactory workaround does not exist
 
  |-
 
  |-
  |'''minor'''
+
  |'''S3'''
  |Minor loss of function, or other problem where easy workaround is present
+
  |(Normal) Blocks non-critical functionality or a work around exists
 
  |-
 
  |-
  |'''trivial'''
+
  |'''S4'''
  |Cosmetic problem like misspelled words or misaligned text
+
  |(Small/Trivial) minor significance, cosmetic issues, low or no impact to users
 
  |-
 
  |-
  |'''enhancement'''
+
  |'''N/A'''
  |Request for enhancement
+
  |(Not Applicable) The above definitions do not apply to this bug; this value is reserved for bugs of type Task or Enhancement
 
  |}  
 
  |}  
 
{{anchor|short_desc}}
 
{{anchor|short_desc}}
Line 124: Line 126:
 
{{anchor|target_milestone}}
 
{{anchor|target_milestone}}
 
; Target Milestone
 
; Target Milestone
: The Target Milestone field is used to define when the engineer the bug is assigned to expects to fix it.
+
: For Firefox-related bugs, when a change set (patch) lands in Mozilla-Central, the [[Sheriffing|sheriffs]] will set this field to the corresponding release value for the current Nightly.
 +
: Release status and tracking flags are used to mark intentions for when a fix or other patch should land.
 +
: If you need to track a bug against a set of milestones other than upcoming versions of Firefox, please tell the Bugzilla team, you may want a custom status flag.  
 
{{anchor|triage_owner}}
 
{{anchor|triage_owner}}
 
; Triage Owner
 
; Triage Owner
: User that is responsible for triaging bugs that are assigned to a specific component.
+
: User that is responsible [https://firefox-source-docs.mozilla.org/bug-mgmt/policies/triage-bugzilla.html for triaging bugs in a specific component].
 +
{{anchor|bug_type}}
 +
; Type
 +
: This field describes the [https://firefox-source-docs.mozilla.org/bug-mgmt/guides/bug-types.html type of a bug].
 +
{| class="wikitable"
 +
|-
 +
! Type !! Description
 +
|-
 +
|'''defect'''
 +
|regression, crash, hang, security vulnerability and any other general issue.
 +
|-
 +
|'''enhancement'''
 +
|new feature, improvement in UI, performance, etc. and any other request for user-facing changes and enhancements in the product; not engineering changes
 +
|-
 +
|'''task'''
 +
|refactoring, removal, replacement, enabling or disabling of functionality and any other engineering task
 +
|}
 
{{anchor|bug_file_loc}}
 
{{anchor|bug_file_loc}}
 
; URL
 
; URL
Line 136: Line 156:
 
{{anchor|votes}}
 
{{anchor|votes}}
 
; Votes
 
; Votes
: Some bugs can be voted for, and you can limit your search to bugs with more than a certain number of votes.
+
: Some bugs can be voted for, and you can limit your search to bugs with more than a certain number of votes. Votes are not used by Mozilla developers to set priorities.
 
{{anchor|status_whiteboard}}
 
{{anchor|status_whiteboard}}
 
; Whiteboard
 
; Whiteboard
 
: Each bug has a free-form single line text entry box for adding tags and status information
 
: Each bug has a free-form single line text entry box for adding tags and status information

Latest revision as of 14:22, 14 May 2024

Bugzilla Field Descriptions

Alias
A short, unique name assigned to a bug in order to assist with looking it up and referring to it in other places in Bugzilla.

Assignee
This is the person in charge of resolving the bug. Every time this field changes, the status changes to NEW to make it easy to see which new bugs have appeared on a person's list.

Blocks
This bug must be resolved before the bugs listed in this field can be resolved.

Bug ID
The numeric id of a bug, unique within this entire installation of Bugzilla.

CC
Users who may not have a direct role to play on this bug, but who are interested in its progress.

Changed
When this bug was last updated.

Classification
Bugs are categorised into Classifications, Products and Components. classifications is the top-level categorization.

Comment
Bugs have comments added to them by Bugzilla users. You can search for some text in those comments.

Comment Tag
Comments can have arbitrary tags added to them to help with filtering as well as mark comments as spam or abusive.

Component
Components are second-level categories; each belongs to a particular Product. Select a Product to narrow down this list.

Creation date
When the bug was filed.

Depends on
The bugs listed here must be resolved before this bug can be resolved.

Duplicates
List of bugs that have been marked a duplicate of the bug currently being viewed.

Keywords
Keywords are a controlled vocabulary for characterizing bugs across Products and Components. Examples of this field are regression, sec-high, and topcrash. Bugzilla administrators manage the list of keywords. If you believe you need a new keyword, please contact the administrators to discuss.

Mentors
Mentors are users who have offered to help the bug owner with such tasks as setting up a development environment, finding relevant information to fixing the bug, how to submit a patch for review, and finally how to get the fix committed.

Needinfo
More information has been requested from specific individuals, or anyone, to move the bug forward to completion.

OS
This is the operating system against which the bug was reported.

Platform
This is the hardware platform against which the bug was reported (ARM, ARM64, x86, x86_64, etc).

Priority
Priority Description
-- No decision
P1 Fix in the current release cycle
P2 Fix in the next release cycle or the following (nightly + 1 or nightly + 2)
P3 Backlog
P4 Do not use. This priority is for the Web Platform Test bot.
P5 Will not fix, but will accept a patch
This field describes the importance and order in which a bug should be fixed compared to other bugs. This field is utilized by the programmers/engineers/release managers/managers to prioritize the work to be done. See the Firefox triage documentation and priority definitions, or for the main Bugzilla project, Bugzilla:Priority_System.

Product
Bugs are categorised into Products and Components. Select a Classification to narrow down this list.

QA Contact
The person responsible for confirming this bug if it is unconfirmed, and for verifying the fix once the bug has been resolved.

Rank
Used by some groups to provide finer-grained ordering for working on bugs than afforded by the Priority field. Use of this field is restricted to the `rank-setters` group.

Regressed by
This bug has been introduced by the bugs listed here.

Regressions
This bug has introduced the bugs listed here.

Reporter
The person who filed this bug.

See Also
This allows you to refer to bugs in other bug tracker installations. You can enter a URL to a bug in the 'Add Bug URLs' field to note that that bug is related to this one. You can enter multiple URLs at once by separating them with a comma. You should normally use this field to refer to bugs in other bug tracker installations, or bugs which are related to, but not known to be duplicates of the bug. Bugs which are regressions should be listed in the Regressed by field (above)

Severity
This field describes the impact of a bug. This field is utilized by the programmers/engineers/release managers/managers to determine the severity of issues and used as input for the priority of the bug. It should not be set by people filing bugs. See the Firefox triage documentation and severity documentation.
Severity Description
-- Default value for new bugs; bug triagers for components (ie engineers and other core project folks) are expected to update the bug's severity from this value. To avoid them missing new bugs for triage, do not alter this default when filing bugs.
S1 (Catastrophic) Blocks development/testing, may impact more than 25% of users, causes data loss, likely dot release driver, and no workaround available
S2 (Serious) Major functionality/product severely impaired or a high impact issue and a satisfactory workaround does not exist
S3 (Normal) Blocks non-critical functionality or a work around exists
S4 (Small/Trivial) minor significance, cosmetic issues, low or no impact to users
N/A (Not Applicable) The above definitions do not apply to this bug; this value is reserved for bugs of type Task or Enhancement

Summary
The bug summary is a short sentence which succinctly describes what the bug is about.

Target Milestone
For Firefox-related bugs, when a change set (patch) lands in Mozilla-Central, the sheriffs will set this field to the corresponding release value for the current Nightly.
Release status and tracking flags are used to mark intentions for when a fix or other patch should land.
If you need to track a bug against a set of milestones other than upcoming versions of Firefox, please tell the Bugzilla team, you may want a custom status flag.

Triage Owner
User that is responsible for triaging bugs in a specific component.

Type
This field describes the type of a bug.
Type Description
defect regression, crash, hang, security vulnerability and any other general issue.
enhancement new feature, improvement in UI, performance, etc. and any other request for user-facing changes and enhancements in the product; not engineering changes
task refactoring, removal, replacement, enabling or disabling of functionality and any other engineering task

URL
Bugs can have a URL associated with them - for example, a pointer to a web site where the problem is seen.

Version
The version field defines the version of the software the bug was found in.

Votes
Some bugs can be voted for, and you can limit your search to bugs with more than a certain number of votes. Votes are not used by Mozilla developers to set priorities.

Whiteboard
Each bug has a free-form single line text entry box for adding tags and status information