BMO/UserGuide/BugFields: Difference between revisions

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

@@ Line 1: / Line 1: @@
 == Bugzilla Field Descriptions ==
-{{anchor|%complete}}
-; %Complete
-: How close to 100% done this bug is, by comparing its Hours Worked to its Orig. Est..
 {{anchor|alias}}
 ; Alias
@@ Line 30: / Line 27: @@
 {{anchor|comment_tag}}
 ; Comment Tag
-: FIXME
+: Comments can have arbitrary tags added to them to help with filtering as well as mark comments as spam or abusive.
 {{anchor|component}}
 ; Component
 : Components are second-level categories; each belongs to a particular Product. Select a Product to narrow down this list.
-{{anchor|cf_crash_signature}}
-; Crash Signature
-: FIXME
 {{anchor|creation_ts}}
 ; Creation date
 : When the bug was filed.
-{{anchor|deadline}}
+{{anchor|dependson}}
-; Deadline
-: The date that this bug must be resolved by, entered in YYYY-MM-DD format.
-{{anchor|depends_on}}
 ; Depends on
 : The bugs listed here must be resolved before this bug can be resolved.
-{{anchor|cf_due_date}}
+{{anchor|duplicates}}
-; Due Date
+; Duplicates
-: FIXME
+: List of bugs that have been marked a duplicate of the bug currently being viewed.
+{{anchor|keywords}}
+; Keywords
+: 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}}
+; 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.
+{{anchor|needinfo}}
+; Needinfo
+: More information has been requested from specific individuals, or anyone, to move the bug forward to completion.
+{{anchor|op_sys}}
+; OS
+: This is the operating system against which the bug was reported.
 {{anchor|rep_platform}}
-; Hardware
+; Platform
-: This is the hardware platform against which the bug was reported.
+: This is the hardware platform against which the bug was reported (ARM, ARM64, x86, x86_64, etc).
+{{anchor|priority}}
+; Priority
+{| 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
+|}
-Hours Left
+: 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]].
-    The number of hours of work left on this bug, calculated by subtracting the Hours Worked from the Orig. Est..
+{{anchor|product}}
-Hours Worked
+; Product
-    The total amount of time spent on this bug so far.
+: Bugs are categorised into Products and Components. Select a Classification to narrow down this list.
-Importance
+{{anchor|qa_contact}}
-    The importance of a bug is described as the combination of its Priority and Severity.
+; QA Contact
-Iteration
+: The person responsible for confirming this bug if it is unconfirmed, and for verifying the fix once the bug has been resolved.
-    A custom Drop Down field in this installation of Bugzilla.
+{{anchor|rank}}
-Keywords
+; Rank
-    You can add keywords from a defined list to bugs, in order to easily identify and group them.
+: 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.
-Last Resolved
+{{anchor|regressed_by}}
-    A custom Date/Time field in this installation of Bugzilla.
+; Regressed by
-Last Visit
+: This bug has been introduced by the bugs listed here.
-    A custom Date/Time field in this installation of Bugzilla.
+{{anchor|regresses}}
-Locale
+; Regressions
-    A custom Multiple-Selection Box field in this installation of Bugzilla.
+: This bug has introduced the bugs listed here.
-Machine State
+{{anchor|reporter}}
-    A custom Drop Down field in this installation of Bugzilla.
+; Reporter
-Mentor
+: The person who filed this bug.
-    A custom Unknown Type field in this installation of Bugzilla.
+{{anchor|see_also}}
-Mozilla Project
+; See Also
-    A custom Drop Down field in this installation of Bugzilla.
+: 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)
-Office/Space
+{{anchor|bug_severity}}
-    A custom Drop Down field in this installation of Bugzilla.
+; Severity
-Orig. Est.
+: 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].
-    The amount of time that has been estimated it will take to resolve this bug.
+{| class="wikitable"
-OS
+ |-
-    This is the operating system against which the bug was reported. Legal operating systems include:
+ ! Severity !! Description
+ |-
-        All (happens on all operating systems; cross-platform bug)
+ |'''--'''
-        Windows 7
+ |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.
-        Mac OS X
+ |-
-        Linux
+ |'''S1'''
+ |(Catastrophic) Blocks development/testing, may impact more than 25% of users, causes data loss, likely dot release driver, and no workaround available
-    Sometimes the operating system implies the platform, but not always. For example, Linux can run on x86_64, ARM, and others.
+ |-
-Points
+ |'''S2'''
-    A custom Drop Down field in this installation of Bugzilla.
+ |(Serious) Major functionality/product severely impaired or a high impact issue and a satisfactory workaround does not exist
-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.
+ |'''S3'''
-Product
+ |(Normal) Blocks non-critical functionality or a work around exists
-    Bugs are categorised into Products and Components. Select a Classification to narrow down this list.
+ |-
-QA Contact
+ |'''S4'''
-    The person responsible for confirming this bug if it is unconfirmed, and for verifying the fix once the bug has been resolved.
+ |(Small/Trivial) minor significance, cosmetic issues, low or no impact to users
-QA Whiteboard
+ |-
-    A custom Free Text field in this installation of Bugzilla.
+ |'''N/A'''
-Rank
+ |(Not Applicable) The above definitions do not apply to this bug; this value is reserved for bugs of type Task or Enhancement
-    A custom Integer field in this installation of Bugzilla.
+ |}
-relnote-b2g
+{{anchor|short_desc}}
-    A custom Extension field in this installation of Bugzilla.
+; Summary
-relnote-firefox
+: The bug summary is a short sentence which succinctly describes what the bug is about.
-    A custom Extension field in this installation of Bugzilla.
+{{anchor|target_milestone}}
-Reporter
+; Target Milestone
-    The person who filed this bug.
+: 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.
-Restrict Comments
+: Release status and tracking flags are used to mark intentions for when a fix or other patch should land.
-    A custom Unknown Type field in this installation of Bugzilla.
+: 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.
-See Also
+{{anchor|triage_owner}}
-    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.
+; Triage Owner
+: User that is responsible [https://firefox-source-docs.mozilla.org/bug-mgmt/policies/triage-bugzilla.html for triaging bugs in a specific component].
-    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.
+{{anchor|bug_type}}
-Severity
+; Type
-    This field describes the impact of a bug.
+: This field describes the [https://firefox-source-docs.mozilla.org/bug-mgmt/guides/bug-types.html type of a bug].
-    blocker   Blocks development and/or testing work
+{| class="wikitable"
-    critical   crashes, loss of data, severe memory leak
+ |-
-    major   major loss of function
+ ! Type !! Description
-    normal   regular issue, some loss of functionality under specific circumstances
+ |-
-    minor   minor loss of function, or other problem where easy workaround is present
+ |'''defect'''
-    trivial   cosmetic problem like misspelled words or misaligned text
+ |regression, crash, hang, security vulnerability and any other general issue.
-    enhancement   Request for enhancement
+ |-
-Summary
+ |'''enhancement'''
-    The bug summary is a short sentence which succinctly describes what the bug is about.
+ |new feature, improvement in UI, performance, etc. and any other request for user-facing changes and enhancements in the product; not engineering changes
-Tags
+ |-
-    A custom Unknown Type field in this installation of Bugzilla.
+ |'''task'''
-Target Milestone
+ |refactoring, removal, replacement, enabling or disabling of functionality and any other engineering task
-    The Target Milestone field is used to define when the engineer the bug is assigned to expects to fix it.
+ |}
-Triage Owner
+{{anchor|bug_file_loc}}
-    A custom Unknown Type field in this installation of Bugzilla.
+; URL
-URL
+: Bugs can have a URL associated with them - for example, a pointer to a web site where the problem is seen.
-    Bugs can have a URL associated with them - for example, a pointer to a web site where the problem is seen.
+{{anchor|version}}
-User Story
+; Version
-    A custom Large Text Box field in this installation of Bugzilla.
+: The version field defines the version of the software the bug was found in.
-ux-b2g
+{{anchor|votes}}
-    A custom Extension field in this installation of Bugzilla.
+; Votes
-Version
+: 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.
-    The version field defines the version of the software the bug was found in.
+{{anchor|status_whiteboard}}
-Votes
+; Whiteboard
-    Some bugs can be voted for, and you can limit your search to bugs with more than a certain number of votes.
+: Each bug has a free-form single line text entry box for adding tags and status information
-Whiteboard
-    Each bug has a free-form single line text entry box for adding tags and status information

BMO/UserGuide/BugFields: Difference between revisions

Latest revision as of 14:22, 14 May 2024

Bugzilla Field Descriptions

Navigation menu

Search