Google Git
Sign in
android / platform / frameworks / support / e2f875c24df8b0c24de4df8cbc6548f222cb78ed / . / docs / issue_tracking.md
blob: 8f7f4e8f64a97a7ccf6c88f32948c29057b77936 [file] [log] [blame] [view]
AndroidX Core Team2e416b22020-12-03 22:58:07 +0000[diff] [blame]1# Issue Lifecycle and Reporting Guidelines
2
3[TOC]
4
AndroidX Core Team0e7745f2021-04-08 17:00:10 +0000[diff] [blame]5## Issue tracker {#tracker}
AndroidX Core Team2e416b22020-12-03 22:58:07 +0000[diff] [blame]6
7The public-facing issue tracker URL is
8[issuetracker.google.com](https://issuetracker.google.com). If you visit this
AndroidX Core Team0e7745f2021-04-08 17:00:10 +0000[diff] [blame]9URL from a Google-internal account, it will immediately redirect you to the
10internal-facing issue tracker URL. Make sure that any links you paste publicly
11have the correct public-facing URL.
AndroidX Core Team2e416b22020-12-03 22:58:07 +0000[diff] [blame]12
13The top-level Jetpack component is
14[`Android Public Tracker > App Development > Jetpack (androidx)`](https://issuetracker.google.com/components/192731/manage#basic).
15
AndroidX Core Team0e7745f2021-04-08 17:00:10 +0000[diff] [blame]16## Reporting guidelines {#reporting}
AndroidX Core Team2e416b22020-12-03 22:58:07 +0000[diff] [blame]17
18Issue Tracker isn't a developer support forum. For support information, consider
19[StackOverflow](http://stackoverflow.com).
20
21Support for Google apps is through
22[Google's support site](http://support.google.com/). Support for third-party
23apps is provided by the app's developer, for example through the contact
24information provided on Google Play.
25
261. Search for your bug to see if anyone has already reported it. Don't forget
27 to search for all issues, not just open ones, as your issue might already
28 have been reported and closed. To help you find the most popular results,
29 sort the result by number of stars.
30
311. If you find your issue and it's important to you, star it! The number of
32 stars on a bug helps us know which bugs are most important to fix.
33
341. If no one has reported your bug, file the bug. First, browse for the correct
35 component -- typically this has a 1:1 correspondence with Maven group ID --
36 and fill out the provided template.
37
381. Include as much information in the bug as you can, following the
39 instructions for the bug queue that you're targeting. A bug that simply says
40 something isn't working doesn't help much, and will probably be closed
41 without any action. The amount of detail that you provide, such as a minimal
42 sample project, log files, repro steps, and even a patch set, helps us
43 address your issue.
44
AndroidX Core Team0e7745f2021-04-08 17:00:10 +0000[diff] [blame]45## Status definitions {#status}
AndroidX Core Team2e416b22020-12-03 22:58:07 +0000[diff] [blame]46
47| Status | Description |
48| -------- | ----------------------------------------------------------------- |
49| New | The default for public bugs. Waiting for someone to validate, |
50: : reproduce, or otherwise confirm that this is actionable. :
51| Assigned | Pending action from the assignee. May be reassigned. |
52| Accepted | Actively being worked on by the assignee. Do not reassign. |
53| Fixed | Fixed in the development branch. Do not re-open unless the fix is |
54: : reverted. :
55| WontFix | Covers all the reasons we chose to close the issue without taking |
56: : action (can't repro, working as intended, obsolete). :
57
AndroidX Core Team0e7745f2021-04-08 17:00:10 +0000[diff] [blame]58## Priority criteria and SLOs {#priority}
AndroidX Core Team2e416b22020-12-03 22:58:07 +0000[diff] [blame]59
AndroidX Core Team0e7745f2021-04-08 17:00:10 +0000[diff] [blame]60| Priority | Criteria | Resolution time |
61| -------- | ------------------------------- | ------------------------------ |
62| P0 | This issue is preventing | Less than 1 day. Don't go home |
63: : someone from getting work done : until this is fixed. :
64: : and doesn’t have a workaround. : :
65: : Examples include service : :
66: : outages, work-stopping issues, : :
67: : and build breakages : :
68| P1 | This issue requires rapid | Within the next 7 days |
69: : resolution, but can be dealt : :
70: : with on a slightly longer : :
71: : timeline than P0. Examples : :
72: : include issues that frequently : :
73: : hinder workflow, serious : :
74: : regressions, and ship-blocking : :
75: : issues : :
76| P2 | This issue is important to | Within the next month |
77: : resolve and may block releases. : :
78: : Examples include non-OKR : :
79: : feature requests and infrequent : :
80: : workflow issues. : :
81| P3 | This issue would be nice to | Less than 365 days |
82: : resolve, but it's not going to : :
83: : block any releases. Examples : :
84: : include nice-to-have feature : :
85: : requests, bugs that only : :
86: : affects a small set of use : :
87: : cases, and occasional issues. : :
88| P4 | Issue has not yet been | N/A (must triage in under 14 |
89: : prioritized. : days :
AndroidX Core Team2e416b22020-12-03 22:58:07 +0000[diff] [blame]90
91## Issue lifecycle
92
AndroidX Core Team0e7745f2021-04-08 17:00:10 +0000[diff] [blame]931. When an issue is reported, it is set to `Assigned` status for default
AndroidX Core Team2e416b22020-12-03 22:58:07 +0000[diff] [blame]94 assignee (typically the [library owner](owners.md)) with a priority of
95 **P4**.
AndroidX Core Team2e416b22020-12-03 22:58:07 +0000[diff] [blame]961. Once an issue has been triaged by the assignee, its priority will be raised
97 from **P4** according to severity.
981. The issue may still be reassigned at this point.
99 [Bug bounty](onboarding.md#bug-bounty) issues are likely to change
100 assignees.
1011. A status of **Accepted** means the assignee is actively working on the
102 issue.
1031. A status of **Fixed** means that the issue has been resolved in the
104 development branch. Please note that it may take some time for the fix to
105 propagate into various release channels (internal repositories, Google
106 Maven, etc.). **Do not** re-open an issue because the fix has not yet
107 propagated into a specific release channel. **Do not** re-open an issue that
108 has been fixed unless the fix was reverted or the exact reported issue is
109 still occurring.