Commit f08e9d5
doc: remove onboarding-extras
Migrate last bit of onboarding-extras content to collaborator-guide and
remove onboarding-extras.
PR-URL: #39252
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>1 parent 6466faf commit f08e9d5
4 files changed
Lines changed: 82 additions & 82 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -22,7 +22,6 @@ | |||
| 22 | 22 | /doc/guides/contributing/pull-requests.md @nodejs/tsc | |
| 23 | 23 | /doc/guides/collaborator-guide.md @nodejs/tsc | |
| 24 | 24 | /doc/guides/offboarding.md @nodejs/tsc | |
| 25 | - /doc/guides/onboarding-extras.md @nodejs/tsc | ||
| 26 | 25 | ||
| 27 | 26 | # streams | |
| 28 | 27 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -831,6 +831,86 @@ When things need extra attention, are controversial, or `semver-major`: | |||
| 831 | 831 | ||
| 832 | 832 | If you cannot find who to cc for a file, `git shortlog -n -s <file>` can help. | |
| 833 | 833 | ||
| 834 | + ## Labels | ||
| 835 | + | ||
| 836 | + ### General labels | ||
| 837 | + | ||
| 838 | + * `confirmed-bug`: Bugs you have verified | ||
| 839 | + * `discuss`: Things that need larger discussion | ||
| 840 | + * `feature request`: Any issue that requests a new feature | ||
| 841 | + * `good first issue`: Issues suitable for newcomers to fix | ||
| 842 | + * `meta`: Governance, policies, procedures, etc. | ||
| 843 | + * `tsc-agenda`: Open issues and pull requests with this label will be added to | ||
| 844 | + the Technical Steering Committee meeting agenda | ||
| 845 | + | ||
| 846 | + --- | ||
| 847 | + | ||
| 848 | + * `author-ready` - A pull request is _author ready_ when: | ||
| 849 | + * There is a CI run in progress or completed. | ||
| 850 | + * There is at least one Collaborator approval (or two TSC approvals for | ||
| 851 | + semver-major pull requests). | ||
| 852 | + * There are no outstanding review comments. | ||
| 853 | + | ||
| 854 | + Please always add the `author ready` label to pull requests that qualify. | ||
| 855 | + Please always remove it again as soon as the conditions are not met anymore, | ||
| 856 | + such as if the CI run fails or a new outstanding review comment is posted. | ||
| 857 | + | ||
| 858 | + --- | ||
| 859 | + | ||
| 860 | + * `semver-{minor,major}` | ||
| 861 | + * be conservative – that is, if a change has the remote *chance* of breaking | ||
| 862 | + something, go for semver-major | ||
| 863 | + * when adding a semver label, add a comment explaining why you're adding it | ||
| 864 | + * minor vs. patch: roughly: "does it add a new method / does it add a new | ||
| 865 | + section to the docs" | ||
| 866 | + * major vs. everything else: run last versions tests against this version, if | ||
| 867 | + they pass, **probably** minor or patch | ||
| 868 | + | ||
| 869 | + ### LTS/version labels | ||
| 870 | + | ||
| 871 | + We use labels to keep track of which branches a commit should land on: | ||
| 872 | + | ||
| 873 | + * `dont-land-on-v?.x` | ||
| 874 | + * For changes that do not apply to a certain release line | ||
| 875 | + * Also used when the work of backporting a change outweighs the benefits | ||
| 876 | + * `land-on-v?.x` | ||
| 877 | + * Used by releasers to mark a pull request as scheduled for inclusion in an | ||
| 878 | + LTS release | ||
| 879 | + * Applied to the original pull request for clean cherry-picks, to the backport | ||
| 880 | + pull request otherwise | ||
| 881 | + * `backport-requested-v?.x` | ||
| 882 | + * Used to indicate that a pull request needs a manual backport to a branch in | ||
| 883 | + order to land the changes on that branch | ||
| 884 | + * Typically applied by a releaser when the pull request does not apply cleanly | ||
| 885 | + or it breaks the tests after applying | ||
| 886 | + * Will be replaced by either `dont-land-on-v?.x` or `backported-to-v?.x` | ||
| 887 | + * `backported-to-v?.x` | ||
| 888 | + * Applied to pull requests for which a backport pull request has been merged | ||
| 889 | + * `lts-watch-v?.x` | ||
| 890 | + * Applied to pull requests which the Release working group should consider | ||
| 891 | + including in an LTS release | ||
| 892 | + * Does not indicate that any specific action will be taken, but can be | ||
| 893 | + effective as messaging to non-collaborators | ||
| 894 | + * `release-agenda` | ||
| 895 | + * For things that need discussion by the Release working group | ||
| 896 | + * (for example semver-minor changes that need or should go into an LTS | ||
| 897 | + release) | ||
| 898 | + * `v?.x` | ||
| 899 | + * Automatically applied to changes that do not target `master` but rather the | ||
| 900 | + `v?.x-staging` branch | ||
| 901 | + | ||
| 902 | + Once a release line enters maintenance mode, the corresponding labels do not | ||
| 903 | + need to be attached anymore, as only important bugfixes will be included. | ||
| 904 | + | ||
| 905 | + ### Other labels | ||
| 906 | + | ||
| 907 | + * Operating system labels | ||
| 908 | + * `macos`, `windows`, `smartos`, `aix` | ||
| 909 | + * No `linux` label because it is the implied default | ||
| 910 | + * Architecture labels | ||
| 911 | + * `arm`, `mips`, `s390`, `ppc` | ||
| 912 | + * No `x86{_64}` label because it is the implied default | ||
| 913 | + | ||
| 834 | 914 | ["Merge Pull Request"]: https://help.github.com/articles/merging-a-pull-request/#merging-a-pull-request-on-github | |
| 835 | 915 | [Deprecation]: https://en.wikipedia.org/wiki/Deprecation | |
| 836 | 916 | [SECURITY.md]: https://github.com/nodejs/node/blob/HEAD/SECURITY.md | |
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -81,7 +81,7 @@ The project has two venues for real-time discussion: | |||
| 81 | 81 | * Be nice about closing issues! Let people know why, and that issues and PRs | |
| 82 | 82 | can be reopened if necessary | |
| 83 | 83 | ||
| 84 | - * [**See "Labels"**](./doc/guides/onboarding-extras.md#labels) | ||
| 84 | + * See [Labels][]. | ||
| 85 | 85 | * There is [a bot](https://github.com/nodejs-github-bot/github-bot) that | |
| 86 | 86 | applies subsystem labels (for example, `doc`, `test`, `assert`, or `buffer`) | |
| 87 | 87 | so that we know what parts of the code base the pull request modifies. It is | |
@@ -239,6 +239,7 @@ needs to be pointed out separately during the onboarding. | |||
| 239 | 239 | the [summit](https://github.com/nodejs/summit) repository for details. | |
| 240 | 240 | ||
| 241 | 241 | [Code of Conduct]: https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md | |
| 242 | + [Labels]: doc/guides/collaborator-guide.md#labels | ||
| 242 | 243 | [Landing Pull Requests]: doc/guides/collaborator-guide.md#landing-pull-requests | |
| 243 | 244 | [Publicizing or hiding organization membership]: https://help.github.com/articles/publicizing-or-hiding-organization-membership/ | |
| 244 | 245 | [`author-ready`]: doc/guides/collaborator-guide.md#author-ready-pull-requests | |
0 commit comments