-
Notifications
You must be signed in to change notification settings - Fork 12
Issue labelling
You can find the full list of project labels here for web/desktop, Android and iOS.
We strive to completely cover all applicable issues with these core labels:
-
Type — Every issue is assigned a type:
- T-Defect: Bugs, crashes, hangs, vulnerabilities, or other reported problems (web/desktop, Android and iOS)
- T-Enhancement: New features, changes in functionality, performance boosts, user-facing improvements (web/desktop)
- T-Task: Refactoring, enabling or disabling functionality, other engineering tasks (web/desktop)
- T-Other: Questions, user support, anything else (web/desktop)
-
Severity — Only issues labelled
T-Defect
are also assigned a severity:- S-Critical: Prevents work, causes data loss and/or has no workaround (web/desktop)
- S-Major: Severely degrades major functionality or product features, with no satisfactory workaround (web/desktop)
- S-Minor: Impairs non-critical functionality or suitable workarounds exist (web/desktop)
- S-Tolerable: Low/no impact on users (web/desktop)
-
Occurrence — All issues labelled
T-Defect
are also assigned a prevalence:- O-Frequent: Affects or can be seen by most users regularly or impacts most users' first experience (web/desktop)
- O-Occasional: Affects or can be seen by some users regularly or most users rarely (web/desktop)
- O-Uncommon: Most users are unlikely to come across this or unexpected workflow (web/desktop)
This label may also be used for other types of issues.
-
Area — Most issues are assigned one or several "areas" using one of the many
A-
prefixed labels, e.g.A-Composer
orA-Spaces
. Each area label maps to a group of features or portion of the UI surface in the app. All A-* labels should have a description and the colour should be#bfd4f2
.
We have a handful of other labels which are added on an as-needed basis, and not expected to be exhaustive:
-
Exceptions — Special flags for issues and pull requests:
- X-Needs-Info: This issue is blocked pending further information from the reporter (web/desktop)
- X-Regression: Denotes things breaking which previously worked (web/desktop)
- X-Release-Blocker: Issues which must be resolved before making a release (web/desktop)
-
Good first issue / Help wanted — Well-defined issues which are suitable for folks new to the codebase (web/desktop)
-
A11y / Meta / I18n / Privacy / Security — Issues which fall under these conceptual themes (which apply to many software projects and are not specific to Element)
-
Sponsored — Used internally by Element to denote issues with external funding (web/desktop)
We have reserved the Z-
prefix for ad hoc labels. Please use #ededed
colour new `Z-\ labels.
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.