How Synapse Uses GitHub Labels

[callahad]

Hello! Welcome to Synapse, the reference implementation of a matrix.org homeserver.

Triage Process

Issues

An issue is considered triaged when it has labels for both Type and a Severity (for defects).

Once triaged, issues are separately assigned a Priority label.

The intent is for Type and Severity to be objective and static, while Priority is fluid and changes dynamically in response to the needs of the Matrix.org Foundation and Element's business context.

Pull Requests

Pull requests are not routinely labeled.

Like issues, pull requests may have various Exception labels applied where relevant.

Label Taxonomy

We have several categories of labels, generally denoted by a shared prefix.

Core Labels

We strive to completely cover all applicable issues with these core labels:

1. Type (colour #98e6ae) — Every issue is assigned a type:

   • T-Defect: Bugs, crashes, hangs, vulnerabilities, or other reported problems.
   • T-Enhancement: New features, changes in functionality, performance boosts, user-facing improvements.
   • T-Task: Refactoring, enabling or disabling functionality, other engineering tasks.
   • T-Other: Questions, user support, anything else.

2. Severity (colours #ffeda0 through #bd0026) — All issues labeled T-Defect are also assigned a severity:

   • S-Critical: Prevents work, causes data loss, affects many users, and/or has no workaround.
   • S-Major: Severely degrades major functionality or product features, with no satisfactory workaround.
   • S-Minor: Impairs non-critical functionality, or suitable workarounds exist.
   • S-Tolerable: Purely cosmetic or low / no impact to users.

Other Common Labels

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-Discussion: The Synapse platform team needs to discuss this before further action is taken.
  • X-Needs-Info: This issue is blocked pending further information from the reporter.
  • X-Regression: Denotes things breaking which previously worked.
  • X-Release-Blocker: Issues which must be resolved before making a release.

• Good First Issue / Hacktoberfest — Well-defined issues which are suitable for folks new to the Synapse codebase.

  • Note: If you're looking to contribute, we would appreciate solutions to any issue labeled P3!

• Security — Issues which may present security concerns.

• Sponsored — Used internally by Element to denote issues with external funding.

Ad Hoc Labels (Z-)

(Colour #ededed)

We have reserved the Z- prefix for ad hoc labels.

Any member of the Synapse 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.

Project labels (A-)

(Colour #5319E7)

We have reserved the A- prefix for project labels.

These are cross-platform projects involved with delivering a feature across server, client, and spec. Any member of the Synapse team is welcome to create labels beginning with A- for the prupose of tracking cross-repo initiatives.

[callahad]

(Closing and locking. Though the label process is still being developed, this particular issue intended as a reference; discussion can happen in #synapse-dev:matrix.org)

[richvdh]

I removed the P- labels from the above, which are no longer used.