Skip to content

docs: update maintainer's guide with the latest labels #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mwbrooks merged 3 commits into from
Apr 4, 2025
Merged

docs: update maintainer's guide with the latest labels #12

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
19773c1
docs: update maintainer's guide with up-to-date labels
mwbrooks Apr 4, 2025
948a5d8
docs: add missing period
mwbrooks Apr 4, 2025
09bb229
Merge branch 'main' into mbrooks-maintainers-guide-labels
mwbrooks Apr 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 24 additions & 13 deletions .github/MAINTAINERS_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -664,33 +664,44 @@ definitions:

- `bug`: A confirmed bug report. A bug is considered confirmed when reproduction
steps have been documented and the issue has been reproduced.
- `build`: A change to the build, compile, or CI/CD pipeline.
Copy link
Member Author

@mwbrooks mwbrooks Apr 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the build label

- `changelog`: An issue or pull request that should be mentioned in the public
release notes or CHANGELOG.
- `code health`: An issue or pull request that is focused on internal refactors
Copy link
Member Author

@mwbrooks mwbrooks Apr 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a space in code health

or tests.
- `discussion`: An issue that is purely meant to hold a discussion. Typically
the maintainers are looking for feedback in this issues.
- `documentation`: An issue that is purely about documentation work.
- `duplicate`: An issue that is functionally the same as another issue. Apply
this only if you've linked the other issue by number.
- `enhancement`: A feature request for something this package might not already
do.
- `documentation`: An issue that is purely about documentation work.
- `tests`: An issue that is purely about testing work.
- `experiment`: A change that is accessed behind the --experiment flag or toggle
- `good first issue`: An issue that has a well-defined relatively-small scope,
with clear expectations. It helps when the testing approach is also known.
- `needs info`: An issue that may have claimed to be a bug but was not
reproducible, or was otherwise missing some information.
- `discussion`: An issue that is purely meant to hold a discussion. Typically
the maintainers are looking for feedback in this issues.
- `question`: An issue that is like a support request because the user's usage
was not correct.
- `security`: An issue that has special consideration for security reasons.
Comment on lines +672 to 686
Copy link
Member Author

@mwbrooks mwbrooks Apr 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are unchanged, but ordered alphabetically.

- `good first issue`: An issue that has a well-defined relatively-small scope,
with clear expectations. It helps when the testing approach is also known.
- `duplicate`: An issue that is functionally the same as another issue. Apply
this only if you've linked the other issue by number.
- `semver:major`: A change that requires a semver major release.
- `semver:minor`: A change that requires a semver minor release.
- `semver:patch`: A change that requires a semver patch release.
Comment on lines +687 to +689
Copy link
Member Author

@mwbrooks mwbrooks Apr 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the semver:* labels

Copy link
Member

@zimeg zimeg Apr 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm so pleased that these are alphabetical! 🙏

- `server side issue`: An issue that exists on the Slack Platform, Slack API,
or other remote endpoint.
Comment on lines +690 to +691
Copy link
Member Author

@mwbrooks mwbrooks Apr 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Switched server-side-issue for server side issue and added a period to the sentence


**Triage** is the process of taking new issues that aren't yet "seen" and
marking them with a basic level of information with labels. An issue should have
**one** of the following labels applied:

- `bug`
- `build`
- `code health`
- `discussion`
- `documentation`
- `enhancement`
- `question`
- `needs info`
- `docs`
- `tests`
- `discussion`
- `question`

_Hint: The main triage issues always have a description that starts with `M-T:`_

Expand Down Expand Up @@ -718,7 +729,7 @@ Steps to triage a pull request:
3. **Labels**:
1. One of the following main labels to describe the type of pull request:
- Main labels always have a description that starts with `M-T:`
- Example: `enhancement`, `bug`, `discussion`, `documentation`, `tests`
Copy link
Member

@zimeg zimeg Apr 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👁️‍🗨️ Great catch!

- Example: `enhancement`, `bug`, `discussion`, `documentation`, `code health`
- Note: The main labels are used to organize the automated CHANGELOG
- The `changelog` label denotes changes to document in the public Slack
API Docs release notes
Expand Down
Loading