📘
For Maintainers

The philosophy behind triage is to check issues for validity and accept them into the various Maintainer workflows. Triage is not intended to engage in lengthy discussions on Issues or review Pull Requests. These are separate activities.

The typical triage outcomes are:

Label and accept the Issue or Pull Request with triaged.
Label, request more information, and mark the Issue with needs discussion and triaged.
Reject by closing the Issue or Pull Request with invalid.

Issue Triage

📘
Triage link (is issue, is open, is not triaged)
https://github.com/thousandbrainsproject/tbp.monty/issues?q=is:issue+is:open+-label:triaged

The desired cadence for Issue Triage is at least once per business day.

A Maintainer will check the Issue for validity.

Do not assign priorities or severities to Issues (see: RFC 2 PR and Issue Review).

Do not assign Maintainers to Issues. Issues remain unassigned so that anyone can work on them (see: RFC 2 PR and Issue Review).

Do not reproduce or fix bugs during triage.

Title

A short descriptive title.

Description

Ideally, the Issue creator followed the instructions in the Issue templates.

If not, and more information is needed, do not close the Issue. Instead, proceed with triage, request more information by commenting on the Issue, and add a needs discussion label to indicate that additional information is required. Remember to add the triaged label to indicate that the Issue was triaged after you applied any additional labels.

Validity

A valid Issue is on-topic, well-formatted, contains expected information, and does not violate the code of conduct.

Labels

Multiple labels can be assigned to an Issue.

bug: Apply this label to bug reports.
documentation: Apply this label if the Issue relates to documentation without affecting code.
enhancement: Apply this label if the Issue relates to new functionality or changes in functional code.
infrastructure: Apply this label if the Issue relates to infrastructure like GitHub, continuous integration, continuous deployment, publishing, etc.
invalid: Apply this label if you are rejecting the Issue for validity.
needs discussion: Apply this label if the Issue is missing information to determine what to do with it.
triaged: At a minimum, apply this label if the Issue is valid and you have triaged it.

Pull Request Triage

📘
Triage link (is pull request, is open, is not a draft, is not triaged)
https://github.com/thousandbrainsproject/tbp.monty/pulls?q=is%3Apr+is%3Aopen+-label%3Atriaged+draft%3Afalse

The desired cadence for Pull Request Triage is at least once per business day.

A Maintainer will check the Pull Request for validity.

There are no priorities or severities applied to Pull Requests.

A valid Pull Request is on-topic, well-formatted, contains expected information, and does not violate the code of conduct.

Title

A short descriptive title.

Description

If the Pull Request claims to resolve an Issue, that Issue is linked and valid.

If the Pull Request is standalone, it clearly and concisely describes what is being proposed and changed.

If the Pull Request is related to a previous RFC process, the RFC document is referenced.

Commit History

Pull Request branches from a recent main commit.

It is OK if the commit history is messy. It will be "squashed" when merged.

Labels

Multiple labels can be assigned to a Pull Request. For example, an enhancement can come with documentation and continue along the Pull Request Flow after being triaged.

documentation: Apply this label if the Pull Request relates to documentation without affecting code.
enhancement: Apply this label if the Pull Request implements new functionality or changes functional code.
infrastructure: Apply this label if the Pull Request concerns infrastructure such as GitHub, continuous integration, continuous deployment, publishing, etc.
invalid: Apply this label if you are rejecting the Pull Request for validity.
rfc:proposal: Apply this label if the Pull Request is a Request For Comments (RFC).
triaged: At a minimum, apply this label if the Pull Request is valid, you triaged it, and it should continue the Pull Request Flow.