Skip to content

Commit 37752cd

Browse files
TrottMylesBorins
authored andcommitted
doc: revise onboarding-extras
Revise onboarding-extras for style guide conformance and minor wording improvements. PR-URL: #34496 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent 050866d commit 37752cd

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

doc/guides/onboarding-extras.md

+16-17
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Additional Onboarding Information
1+
# Additional onboarding information
22

33
## Labels
44

@@ -11,30 +11,29 @@
1111
* `test`
1212
* `tools`
1313

14-
There may be more than one subsystem valid for any particular issue or pull
15-
request.
14+
More than one subsystem may be valid for any particular issue or pull request.
1615

1716
### General
1817

19-
* `confirmed-bug` - Bugs you have verified exist
20-
* `discuss` - Things that need larger discussion
21-
* `feature request` - Any issue that requests a new feature (usually not PRs)
22-
* `good first issue` - Issues suitable for newcomers to process
23-
* `meta` - For issues whose topic is governance, policies, procedures, etc.
24-
* `tsc-agenda` - Open issues and pull requests with this label will be added to
18+
* `confirmed-bug`: Bugs you have verified
19+
* `discuss`: Things that need larger discussion
20+
* `feature request`: Any issue that requests a new feature
21+
* `good first issue`: Issues suitable for newcomers to fix
22+
* `meta`: Governance, policies, procedures, etc.
23+
* `tsc-agenda`: Open issues and pull requests with this label will be added to
2524
the Technical Steering Committee meeting agenda
2625

2726
---
2827

2928
* `author-ready` - A pull request is _author ready_ when:
3029
* There is a CI run in progress or completed.
31-
* There is at least one Collaborator approval (or two TSC approvals
32-
for semver-major PRs).
30+
* There is at least one Collaborator approval (or two TSC approvals for
31+
semver-major PRs).
3332
* There are no outstanding review comments.
3433

35-
Please always add the `author ready` label to the pull request in that case.
34+
Please always add the `author ready` label to pull requests that qualify.
3635
Please always remove it again as soon as the conditions are not met anymore,
37-
such as if CI run fails or a new outstanding review comment is posted.
36+
such as if the CI run fails or a new outstanding review comment is posted.
3837

3938
---
4039

@@ -47,7 +46,7 @@ such as if CI run fails or a new outstanding review comment is posted.
4746
* major vs. everything else: run last versions tests against this version, if
4847
they pass, **probably** minor or patch
4948

50-
### LTS/Version labels
49+
### LTS/version labels
5150

5251
We use labels to keep track of which branches a commit should land on:
5352

@@ -82,11 +81,11 @@ We use labels to keep track of which branches a commit should land on:
8281
Once a release line enters maintenance mode, the corresponding labels do not
8382
need to be attached anymore, as only important bugfixes will be included.
8483

85-
### Other Labels
84+
### Other labels
8685

8786
* Operating system labels
8887
* `macos`, `windows`, `smartos`, `aix`
89-
* No linux, linux is the implied default
88+
* No `linux` label because it is the implied default
9089
* Architecture labels
9190
* `arm`, `mips`, `s390`, `ppc`
92-
* No x86{_64}, since that is the implied default
91+
* No `x86{_64}` label because it is the implied default

0 commit comments

Comments
 (0)