From c95964afd6cc2c6c94faba0e6f31945d24e23499 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 23 Jul 2020 11:59:36 -0700 Subject: [PATCH] doc: revise onboarding-extras MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Revise onboarding-extras for style guide conformance and minor wording improvements. PR-URL: https://github.com/nodejs/node/pull/34496 Reviewed-By: Michaël Zasso Reviewed-By: Trivikram Kamat --- doc/guides/onboarding-extras.md | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/doc/guides/onboarding-extras.md b/doc/guides/onboarding-extras.md index 6904713ce7ed67..030074093eef36 100644 --- a/doc/guides/onboarding-extras.md +++ b/doc/guides/onboarding-extras.md @@ -1,4 +1,4 @@ -# Additional Onboarding Information +# Additional onboarding information ## Labels @@ -11,30 +11,29 @@ * `test` * `tools` -There may be more than one subsystem valid for any particular issue or pull -request. +More than one subsystem may be valid for any particular issue or pull request. ### General -* `confirmed-bug` - Bugs you have verified exist -* `discuss` - Things that need larger discussion -* `feature request` - Any issue that requests a new feature (usually not PRs) -* `good first issue` - Issues suitable for newcomers to process -* `meta` - For issues whose topic is governance, policies, procedures, etc. -* `tsc-agenda` - Open issues and pull requests with this label will be added to +* `confirmed-bug`: Bugs you have verified +* `discuss`: Things that need larger discussion +* `feature request`: Any issue that requests a new feature +* `good first issue`: Issues suitable for newcomers to fix +* `meta`: Governance, policies, procedures, etc. +* `tsc-agenda`: Open issues and pull requests with this label will be added to the Technical Steering Committee meeting agenda --- * `author-ready` - A pull request is _author ready_ when: * There is a CI run in progress or completed. - * There is at least one Collaborator approval (or two TSC approvals - for semver-major PRs). + * There is at least one Collaborator approval (or two TSC approvals for + semver-major PRs). * There are no outstanding review comments. -Please always add the `author ready` label to the pull request in that case. +Please always add the `author ready` label to pull requests that qualify. Please always remove it again as soon as the conditions are not met anymore, -such as if CI run fails or a new outstanding review comment is posted. +such as if the CI run fails or a new outstanding review comment is posted. --- @@ -47,7 +46,7 @@ such as if CI run fails or a new outstanding review comment is posted. * major vs. everything else: run last versions tests against this version, if they pass, **probably** minor or patch -### LTS/Version labels +### LTS/version labels We use labels to keep track of which branches a commit should land on: @@ -82,11 +81,11 @@ We use labels to keep track of which branches a commit should land on: Once a release line enters maintenance mode, the corresponding labels do not need to be attached anymore, as only important bugfixes will be included. -### Other Labels +### Other labels * Operating system labels * `macos`, `windows`, `smartos`, `aix` - * No linux, linux is the implied default + * No `linux` label because it is the implied default * Architecture labels * `arm`, `mips`, `s390`, `ppc` - * No x86{_64}, since that is the implied default + * No `x86{_64}` label because it is the implied default