Skip to content

Instantly share code, notes, and snippets.

@RebeccaWhit3
Last active July 25, 2018 17:22
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save RebeccaWhit3/3728db73cf065c9ebe37387f862bd119 to your computer and use it in GitHub Desktop.
Save RebeccaWhit3/3728db73cf065c9ebe37387f862bd119 to your computer and use it in GitHub Desktop.
Issue (bug) documentation templates

Issue documentation templates

Taken from bugs.chromium.org.

Each template includes an "attach a file" option, unless stated otherwise.

Templates

Android Issue

Summary:

Enter one-line summary

Description:

Device name:

From "Settings > About Chrome"
Application version:
Operating system:

URLs (if applicable):

Steps to reproduce:
(1)
(2)
(3)

Expected result:


Actual result:

Audio/Video Issue

Summary:

Enter one-line summary

Description:

Chrome Version       : <copy from chrome://version>
URLs (if applicable) :
OS version               :
Network (such as Cable/DSL/Dial up etc):
Audio/Video format (if applicable):
Special chrome flags (if applicable):

Behavior in Safari (if known):
Behavior in Firefox (if known):

Video issue, Audio issue, both, neither?

Flash or HTML5?  <right-clicking most players will either reveal some text
with “Flash”; otherwise likely HTML5>

If the browser or renderer crashed (“Aw, Snap”), please add any crash
IDs from chrome://crashes  (possibly after enabling crash reporting per
http://support.google.com/chrome/bin/answer.py?hl=en&answer=96817)

What steps will reproduce the problem?
(1)
(2)
(3)

What is the expected result?

What is the actual result?

Any additional information (anything else which may help us debug the
issue)?


Please attach the HTML5/JavaScript code or audio/video files as well as
screenshot and/or videos (if applicable)

Defect on Linux

Summary:

Enter one-line summary

Description:

Chrome Version (from the about:version page):
Is this the most recent version:
OS + version:
CPU architecture (32-bit / 64-bit):
Window manager:
URLs (if relevant):
Behavior in Linux Firefox:
Behavior in Windows Chrome (if you have access to it):

What steps will reproduce the problem?
(1)
(2)
(3)

What is the expected result?


What happens instead?


Please provide any additional information below. Attach a screenshot
and backtrace if possible.

For graphics-related bugs, please copy/paste the contents of the about:gpu
page at the end of this report.

Defect on Mac OS

Summary:

Enter one-line summary

Description:

Chrome Version       : <from About Google Chrome/Chromium>
URLs (if applicable) :
OS version               : <from About This Mac>
Behavior in Safari (if applicable):
Behavior in Firefox (if applicable):

What steps will reproduce the problem?
(1)
(2)
(3)

What is the expected result?


What happens instead?

For graphics-related bugs, please copy/paste the contents of the about:gpu
page at the end of this report.

Defect report from user

Summary:

Enter one-line summary

Description:

Chrome Version       : <Copy from: 'about:version'>
URLs (if applicable) :
Other browsers tested:
  Add OK or FAIL, along with the version, after other browsers where you
have tested this issue:
     Safari:
    Firefox:
         IE:

What steps will reproduce the problem?
(1)
(2)
(3)

What is the expected result?


What happens instead?


Please provide any additional information below. Attach a screenshot if
possible.

Kiosk issue (feature specific)

Summary:

Enter one-line summary

Description:

Version:
OS:

What steps will reproduce the problem?
(1)
(2)
(3)


What is the expected result?


What happens instead?


Please use labels and text to provide additional information.

Label Request (?)

Summary:

Enter one-line summary

Description:

1] Label Name: _____

Guideline 1: Unless a hierarchy of labels is needed, please avoid creating
new root parents.
Guideline 2: Proj(ects) labels should be used for efforts that have a clear
start/ end
Guideline 3: Hotlist labels should be used for tracking on-going efforts
across multiple components (e.g. Hotlist-GoodFirstBug)
Guideline 4: Due to the way auto-complete works we avoid using hyphens to
express anything other than hierarchy (e.g. UI-Browser-Omnibox).  We use
CamelCase to represent multiple words (e.g. Hotlist-CamelCase versus
Hotlist-Camel-Case).


2] Parent Label (e.g. Proj-, Hotlist-, etc...): _____

Note: We generally avoid creating new component namespaces, unless there is
a new hierarchy that needs to be expressed.  Please try and use existing
label as parents.

3] Description of Label: _______

4] Please specify what triage practices will be followed for the label
(i.e. what team will do it and how frequently).

Memory Usage

Summary:

Enter one-line summary

Description:

Chrome Version: <Copy from: 'about:version'>
OS:
See <http://www.chromium.org/for-testers/providing-memory-details> to
provide memory usage snapshots.

URL (if applicable) where the memory bloat occurred:

Can you reproduce this memory bloat?

What steps will reproduce this memory bloat (or if it's not reproducible,
what were you doing until then)?
(1)
(2)
(3)

*Please note that issues filed with no information filled in above
will be marked as WontFix*

Privacy issues

Summary:

Enter one-line summary

Description:

This template is ONLY for reporting privacy issues. Please use a different
template for other types of bug reports.

Please see http://www.chromium.org/Home/chromium-privacy for further
information.


PRIVACY ISSUE
Please provide a brief summary of the privacy issue.

VERSION:
Chrome Version: [x.x.x.x] + [stable, beta, or dev]
Operating System: [Please indicate OS, version, and service pack level]

REPRODUCTION STEPS
Please provide detailed reproduction steps, and any additional
information below. Include an URL demonstrating the issue and attach a
screenshot if
applicable. Be sure to include in your description how this issue
affects your privacy.

Security - Download Protection Bypass

Summary:

Enter one-line summary

Description:

This template is ONLY for reporting Download Protection Bypass bugs within
Chrome and is not for requesting a review of sites or binaries identified
as malicious.

VERSION
Chrome Version: [x.x.x.x] + [stable, beta, or dev]
Operating System: [Please indicate OS, version, and service pack level]

REPRODUCTION CASE
Please include a demonstration of the Download Protection / Safe Browsing
bug, such as an attached HTML or binary file that reproduces the bug when
loaded in Chrome. PLEASE make the file as small as possible and remove any
content not required to demonstrate the bug.

Security bug

Summary:

Enter one-line summary

Description:

This template is ONLY for reporting security bugs. If you are reporting a
Download Protection Bypass bug, please use the "Security - Download
Protection" template. For all other reports, please use a different
template.

Please READ THIS FAQ before filing a bug: https://www.chromium.org/Home
/chromium-security/security-faq

Please see the following link for instructions on filing security bugs:
http://www.chromium.org/Home/chromium-security/reporting-security-bugs

NOTE: Security bugs are normally made public once a fix has been widely
deployed.

VULNERABILITY DETAILS
Please provide a brief explanation of the security issue.

VERSION
Chrome Version: [x.x.x.x] + [stable, beta, or dev]
Operating System: [Please indicate OS, version, and service pack level]

REPRODUCTION CASE
Please include a demonstration of the security bug, such as an attached
HTML or binary file that reproduces the bug when loaded in Chrome. PLEASE
make the file as small as possible and remove any content not required to
demonstrate the bug.

FOR CRASHES, PLEASE INCLUDE THE FOLLOWING ADDITIONAL INFORMATION
Type of crash: [tab, browser, etc.]
Crash State: [see link above: stack trace, registers, exception record]
Client ID (if relevant): [see link above]

Sync Issue

Summary:

Enter one-line summary

Description:

ENVIRONMENT and STATS
For syncing clients:
From chrome://version, please provide the OS and Chrome build number.
From about:sync, copy/paste the tab contents here, or select the Data tab
and click [Dump sync events to text].

REPRO STEPS
Please describe the sequence of steps to reproduce the problem.

ACTUAL RESULTS
What you are experiencing.

EXPECTED RESULTS
What you expected to happen.

ADDITIONAL INFO
Anything else which may help us debug the issue; screenshots of error
messages or states are always helpful.

Translation Issue

Summary:

Enter one-line summary

Description:

[Language]

[Version number]

[OS details]

[Where is the poor translation?]

[attach any screenshots below]

Webview bugs

Summary:

Enter one-line summary

Description:

THIS TEMPLATE IS FOR FILING BUGS ON THE ANDROID SYSTEM WEBVIEW. GENERAL WEB
BUGS SHOULD BE FILED USING A DIFFERENT TEMPLATE!

Device name:
Android version:
WebView version (from system settings -> Apps -> Android System WebView):
Application:
Application version:

URLs (if applicable):



Steps to reproduce:
(1)
(2)
(3)

Expected result:


Actual result:

Webview-private bugs

Summary:

Enter one-line summary

Description:

This report will ONLY be viewable by Google.

Device name:
Android version:
Fingerprint:
WebView version (from system settings -> Apps -> Android System WebView):
Application:
Application version:

URLs (if applicable):



Steps to reproduce:
(1)
(2)
(3)

Expected result:


Actual result:

Enterprise issue

Summary:

Enter one-line summary

Description:

Version of Google Chrome (Wrench-> About Google Chrome):
Version of MSI (if applicable):
Using group policy settings? Yes/No

[Please enter what issue you are encountering here.  Please do not post any
private URLs or data.  If you are having problems with policy settings,
please post the contents of "about:policy" with any private data removed.]

Broken Webpage

Summary:

Enter one-line summary

Description:

Chrome Version       : <from About Google Chrome/Chromium or
'about:version'>
URL :
Behavior in Safari 4.x/5.x:
Behavior in Firefox 3.x/4.x:

What steps will reproduce the problem?
(1)
(2)
(3)

Crash Report

Chrome Version: <Copy from: 'about:version'>
OS:
Crash ID: <See https://sites.google.com/a/chromium.org/dev/for-testers/bug-
reporting-guidelines/reporting-crash-bug
for instructions>

URL (if applicable) where crash occurred:

Can you reproduce this crash?

What steps will reproduce this crash (or if it's not reproducible,
what were you doing just before the crash)?
(1)
(2)
(3)

*Please note that issues filed with no information filled in above
will be marked as WontFix*

Defect on Windows

Summary:

Enter one-line summary

Description:

Chrome Version       : 56.0.2924.87
OS Version: 10.0
URLs (if applicable) :
Other browsers tested:
  Add OK or FAIL after other browsers where you have tested this issue:
     Safari 5:
  Firefox 4.x:
     IE 7/8/9:

What steps will reproduce the problem?
1.
2.
3.

What is the expected result?


What happens instead of that?


Please provide any additional information below. Attach a screenshot if
possible.

UserAgentString: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36

iOS Issue

Summary:

Enter one-line summary

Description:

Chrome Version (from "Settings > About Google Chrome"):
Device Type: (iPad 2, iPhone 4, etc)
URLs (if applicable):


Behavior in Safari (if applicable):


Steps to reproduce:
(1)
(2)
(3)

Expected result:


Actual result:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment