Merge pull request #16612 from vector-im/jryans/triage-2021

Update triage guide to match the new label scheme
This commit is contained in:
J. Ryan Stinnett 2021-03-10 14:06:37 +00:00 committed by GitHub
commit 779a4912d5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 70 additions and 99 deletions

View File

@ -1,3 +1,5 @@
<!-- A picture's worth a thousand words: PLEASE INCLUDE A SCREENSHOT :P -->
<!-- Please report security issues by email to security@matrix.org --> <!-- Please report security issues by email to security@matrix.org -->
<!-- This is a bug report template. By following the instructions below and <!-- This is a bug report template. By following the instructions below and
@ -36,7 +38,7 @@ file a bug here too! -->
For the web app: For the web app:
- **Browser**: Chrome, Safari, Firefox? which version? - **Browser**: Chrome, Firefox, Safari, Edge? which version?
- **OS**: Windows, macOS, Ubuntu, Arch Linux, etc? - **OS**: Windows, macOS, Ubuntu, Arch Linux, etc?
- **URL**: develop.element.io / app.element.io / somewhere else? If a private server, what version of Element Web? - **URL**: develop.element.io / app.element.io / somewhere else? If a private server, what version of Element Web?

View File

@ -2,11 +2,13 @@
name: Bug report name: Bug report
about: Create a report to help us improve about: Create a report to help us improve
title: '' title: ''
labels: bug labels: T-Defect
assignees: '' assignees: ''
--- ---
<!-- A picture's worth a thousand words: PLEASE INCLUDE A SCREENSHOT :P -->
<!-- Please report security issues by email to security@matrix.org --> <!-- Please report security issues by email to security@matrix.org -->
<!-- This is a bug report template. By following the instructions below and <!-- This is a bug report template. By following the instructions below and
@ -46,7 +48,7 @@ Logs being sent: yes/no
For the web app: For the web app:
- **Browser**: Chrome, Safari, Firefox? which version? - **Browser**: Chrome, Firefox, Safari, Edge? which version?
- **OS**: Windows, macOS, Ubuntu, Arch Linux, etc? - **OS**: Windows, macOS, Ubuntu, Arch Linux, etc?
- **URL**: develop.element.io / app.element.io / somewhere else? If a private server, what version of Element Web? - **URL**: develop.element.io / app.element.io / somewhere else? If a private server, what version of Element Web?

View File

@ -2,7 +2,7 @@
name: Suggestion or Feature request name: Suggestion or Feature request
about: Suggest an idea for this project about: Suggest an idea for this project
title: '' title: ''
labels: suggestion labels: T-Enhancement
assignees: '' assignees: ''
--- ---

View File

@ -1,58 +0,0 @@
---
name: User Interface or Usability Bug report
about: Please include screenshots in UI/UX bug reports
title: ''
labels: bug, ui/ux
assignees: ''
---
<!-- A picture's worth a thousand words: PLEASE INCLUDE A SCREENSHOT :P -->
<!-- Please report security issues by email to security@matrix.org -->
<!-- This is a bug report template. By following the instructions below and
filling out the sections with your information, you will help the us to get all
the necessary data to fix your issue.
You can also preview your report before submitting it. You may remove sections
that aren't relevant to your particular case.
Text between <!-- and --> marks will be invisible in the report.
-->
### Description
Describe here the problem that you are experiencing, or the feature you are requesting.
### Steps to reproduce
- For bugs, list the steps
- that reproduce the bug
- using hyphens as bullet points
Describe how what happens differs from what you expected.
<!-- Please send us logs for your bug report. They're very important for bugs
which are hard to reproduce. To do this, create this issue then go to your
account settings and click 'Submit Debug Logs' from the Help & About tab -->
Logs being sent: yes/no
<!-- Include screenshots if possible: you can drag and drop images below. -->
### Version information
<!-- IMPORTANT: please answer the following questions, to help us narrow down the problem -->
- **Platform**: web (in-browser) or desktop?
For the web app:
- **Browser**: Chrome, Safari, Firefox? which version?
- **OS**: Windows, macOS, Ubuntu, Arch Linux, etc?
- **URL**: develop.element.io / app.element.io / somewhere else? If a private server, what version of Element Web?
For the desktop app:
- **OS**: Windows, macOS, Ubuntu, Arch Linux, etc?
- **Version**: 1.x.y <!-- check the user settings panel if unsure -->

View File

@ -388,51 +388,76 @@ For a developer guide, see the [translating dev doc](docs/translating-dev.md).
Triaging issues Triaging issues
=============== ===============
Issues will be triaged by the core team using the below set of tags. We strive to completely cover all applicable issues with these core labels:
Tags are meant to be used in combination - e.g.: 1. __Type__ — Every issue is assigned a type:
* P1 critical bug == really urgent stuff that should be next in the bugfixing todo list - __[T-Defect](https://github.com/vector-im/element-web/labels/T-Defect):__
* "release blocker" == stuff which is blocking us from cutting the next release. Bugs, crashes, hangs, vulnerabilities, or other reported problems
* P1 feature type:voip == what VoIP features should we be working on next? - __[T-Enhancement](https://github.com/vector-im/element-web/labels/T-Enhancement):__
New features, changes in functionality, performance boosts, user-facing
improvements
- __[T-Task](https://github.com/vector-im/element-web/labels/T-Task):__
Refactoring, enabling or disabling functionality, other engineering tasks
- __[T-Other](https://github.com/vector-im/element-web/labels/T-Other):__
Questions, user support, anything else
priority: **compulsory** 2. __Severity__ — All issues labeled `T-Defect` are also assigned a severity:
* __[S-Critical](https://github.com/vector-im/element-web/labels/S-Critical):__
Prevents work, causes data loss, affects many users, and/or has no
workaround
* __[S-Major](https://github.com/vector-im/element-web/labels/S-Major):__
Severely degrades major functionality or product features, with no
satisfactory workaround
* __[S-Minor](https://github.com/vector-im/element-web/labels/S-Minor):__
Impairs non-critical functionality, or suitable workarounds exist
* __[S-Tolerable](https://github.com/vector-im/element-web/labels/S-Tolerable):__
Purely cosmetic or low / no impact to users
* P1: top priority - i.e. pool of stuff which we should be working on next 3. __Priority__ — All issues which are not `T-Other` are assigned a priority:
* P2: still need to fix, but lower than P1 * __[P1](https://github.com/vector-im/element-web/labels/P1):__ Next
* P3: non-urgent * __[P2](https://github.com/vector-im/element-web/labels/P2):__ Later
* P4: interesting idea - bluesky some day * __[P3](https://github.com/vector-im/element-web/labels/P3):__ Eventually
* P5: recorded for posterity/to avoid duplicates. No intention to resolves right now. * __[P4](https://github.com/vector-im/element-web/labels/P4):__ Interesting —
Not yet scheduled, will accept patches
* __[P5](https://github.com/vector-im/element-web/labels/P5):__ Dubious —
Will not schedule, would consider patches
bug or feature: **compulsory** 4. __Area__ — Most issues are assigned one or several "areas" using one of the
many `A-` prefixed labels, e.g. `A-Composer` or `A-Spaces`. Each area label
maps to a group of features or portion of the UI surface in the app.
* bug ### Other common labels
* feature
bug severity: **compulsory, if bug** We have a handful of other labels which are added on an as-needed basis, and not expected to be exhaustive:
* critical - whole app doesn't work * __Exceptions__ — Special flags for issues and pull requests:
* major - entire feature doesn't work * __[X-Needs-Info](https://github.com/vector-im/element-web/labels/X-Needs-Info):__
* minor - partially broken feature (but still usable) This issue is blocked pending further information from the reporter
* cosmetic - feature works functionally but UI/UX is broken * __[X-Regression](https://github.com/vector-im/element-web/labels/X-Regression):__
Denotes things breaking which previously worked
* __[X-Release-Blocker](https://github.com/vector-im/element-web/labels/X-Release-Blocker):__
Issues which must be resolved before making a release
types * __[Easy](https://github.com/vector-im/element-web/labels/Easy)__ / __[Help
* type:* - refers to a particular part of the app; used to filter bugs Wanted](https://github.com/vector-im/element-web/labels/Help%20Wanted)__ —
on a given topic - e.g. VOIP, signup, timeline, etc. Well-defined issues which are suitable for folks new to the codebase
additional categories (self-explanatory): * __[A11y](https://github.com/vector-im/element-web/labels/A11y)__ /
__[Meta](https://github.com/vector-im/element-web/labels/Meta)__ /
__[I18n](https://github.com/vector-im/element-web/labels/I18n)__ /
__[Privacy](https://github.com/vector-im/element-web/labels/Privacy)__ /
__[Security](https://github.com/vector-im/element-web/labels/Security)__ —
Issues which fall under these conceptual themes (which apply to many software
projects and are not specific to Element)
* release blocker * __[Sponsored](https://github.com/vector-im/element-web/labels/Sponsored)__ —
* ui/ux (think of this as cosmetic) Used internally by Element to denote issues with external funding
* network (specific to network conditions)
* platform specific
* accessibility
* maintenance
* performance
* i18n
* blocked - whether this issue currently can't be progressed due to outside factors
community engagement ### Ad hoc labels (`Z-`)
* easy
* hacktoberfest We have reserved the `Z-` prefix for ad hoc labels.
* bounty? - proposal to be included in a bounty programme
* bounty - included in Status Open Bounty Any member of the core team is welcome to create labels beginning with `Z-` for
any purpose, such as tracking personal areas of interest or providing a common
way to label cross-repo initiatives. The prefix avoids interference with the
project's main labels.