From 9ad57e6cb3acbffc5931a0d337efca8b0d7eb074 Mon Sep 17 00:00:00 2001 From: George Kalpakas Date: Fri, 12 Mar 2021 19:02:44 +0200 Subject: [PATCH] docs: document `help wanted` and `good first issue` labels (#41195) Previously, we used the `hotlist: community-help` label to mark issues that were good candidates for contributions from the community. Recently, we also started using the `good first issue` label to mark issues that would additionally be suitable for first-time contributors. This commit is part of the work to replace `hotlist: community-help` with the newly added `help wanted` label, which (same as `good first issue`) is a [default GitHub label][1]. This commit changes all occurrences of `hotlist: community-help` in the documentation to `help wanted` and also documents the purpose of the `help wanted` and `good first issue` labels. [1]: https://docs.github.com/en/github/managing-your-work-on-github/managing-labels#about-default-labels PR Close #41195 --- README.md | 2 +- docs/TRIAGE_AND_LABELS.md | 18 ++++++++++++++---- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4493c7f8cb..502e692e17 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,7 @@ Read through our [contributing guidelines][contributing] to learn about our subm ### Want to Help? -Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for [contributing][contributing] and then check out one of our issues in the [hotlist: community-help](https://github.com/angular/angular/labels/hotlist%3A%20community-help). +Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for [contributing][contributing] and then check out one of our issues labeled as [help wanted](https://github.com/angular/angular/labels/help%20wanted) or [good first issue](https://github.com/angular/angular/labels/good%20first%20issue). ### Code of Conduct diff --git a/docs/TRIAGE_AND_LABELS.md b/docs/TRIAGE_AND_LABELS.md index 9567c3e098..0f535698a6 100644 --- a/docs/TRIAGE_AND_LABELS.md +++ b/docs/TRIAGE_AND_LABELS.md @@ -53,6 +53,16 @@ Sometimes, especially in the case of cross-cutting issues or PRs, these PRs or i multiple components. In these cases, all applicable component labels should be used to triage the issue or PR. +### Community engagement + +* `help wanted` - Indicates an issue whose complexity/scope makes it suitable for a community contributor to pick up. +* `good first issue` - Indicates an issue that is suitable for first-time contributors. + (This label should be applied _in addition_ to `help wanted` for better discoverability.) + +`help wanted` and `good first issue` are [default GitHub labels] familiar to many developers. + +[default GitHub labels]: https://docs.github.com/en/github/managing-your-work-on-github/managing-labels#about-default-labels + ## Caretaker Triage Process (Initial Triage) The caretaker assigns `comp: *` labels to new issues as they come in. @@ -88,7 +98,7 @@ infeasible, close the issue with a comment explaining why. If the issue is an RFC or discussion, apply the "discussion" label. Use your judgement to determine whether this discussion belongs on GitHub. Discussions here should pertain to the technical implementation details of Angular. Redirect requests for debugging help or advice to a more -appropriate channel unless they're capturing a legitimate bug. +appropriate channel unless they're capturing a legitimate bug. ### Step 3: Set a Priority @@ -104,17 +114,17 @@ For bug reports, set a priority label. | P5 | The team acknowledges the request but (due to any number of reasons) does not plan to work on or accept contributions for this request. The issue remains open for discussion. | -Issues marked with "feature" or "discussion" don't require a priority. +Issues marked with "feature" or "discussion" don't require a priority. ### Step 4: Apply additional information labels Many optional labels provide additional context for issues. Consider adding any of the following if they apply to the issue: -* Browser or operating system labels (`windows`, `ie11`, etc.) +* Browser or operating system labels (`windows`, `browser: ie 11`, etc.) * Labels that inform the severity (`regression`, `has workaround`, `no workaround`) * Labels that categorize the bug (`performance`, `refactoring`, `memory leak`) -* Community engagement labels (`good first issue`) +* Community engagement labels (`help wanted`, `good first issue`) Once this triage is done, the ng-bot automatically changes the milestone from `needs triage` to `Backlog`.