docs: update maintainer's guide with the latest labels #12
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mwbrooks
added
docs
mwbrooks
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #12 +/- ##
=======================================
Coverage 62.82% 62.82%
=======================================
Files 210 210
Lines 22053 22053
=======================================
Hits 13854 13854
Misses 7122 7122
Partials 1077 1077 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
mwbrooks
commented
Apr 4, 2025
|
|
||
| - `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. |
| - `build`: A change to the build, compile, or CI/CD pipeline. | ||
| - `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 |
Member
Author
There was a problem hiding this comment.
Added a space in code health
Comment on lines
+687
to
+689
| - `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. |
Member
Author
There was a problem hiding this comment.
Added the semver:* labels
Member
There was a problem hiding this comment.
I'm so pleased that these are alphabetical! 🙏
Comment on lines
+690
to
+691
| - `server side issue`: An issue that exists on the Slack Platform, Slack API, | ||
| or other remote endpoint. |
Member
Author
There was a problem hiding this comment.
Switched server-side-issue for server side issue and added a period to the sentence
Comment on lines
+672
to
686
| - `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. |
Member
Author
There was a problem hiding this comment.
These are unchanged, but ordered alphabetically.
zimeg
approved these changes
Apr 4, 2025
Comment on lines
+687
to
+689
| - `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. |
Member
There was a problem hiding this comment.
I'm so pleased that these are alphabetical! 🙏
| 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` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This pull request updates the
MAINTAINERS_GUIDE.mdwith our latest labels and descriptions. I also organized the list of labels alphabetically, so it's easier to compare with the GitHub Labels.Requirements