iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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
This commit is contained in:
George Kalpakas 2021-03-12 19:02:44 +02:00 committed by Jessica Janiuk
parent 937e90cd16
commit 9ad57e6cb3
2 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -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 <kbd>[help wanted](https://github.com/angular/angular/labels/help%20wanted)</kbd> or <kbd>[good first issue](https://github.com/angular/angular/labels/good%20first%20issue)</kbd>.
### Code of Conduct

14
docs/TRIAGE_AND_LABELS.md
View File

@ -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.)
<sub>`help wanted` and `good first issue` are [default GitHub labels] familiar to many developers.</sub>
[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.
@ -111,10 +121,10 @@ Issues marked with "feature" or "discussion" don't require a priority.
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`.