diff options
| author | Pooja D.P <Pooja.D.P@ibm.com> | 2020-10-20 15:13:21 +0300 |
|---|---|---|
| committer | Node.js GitHub Bot <github-bot@iojs.org> | 2020-10-27 08:40:35 +0300 |
| commit | 8f1e4d37bf33b8a4d3e09bffc1bcbb04c869eba0 (patch) | |
| tree | 3d13b6e837108e1eb69ec33e572b7c22b3bc5795 | |
| parent | 16b2bc01ebabe7b00f901f94cfa592675e7d2d8a (diff) | |
doc: add a subsystems header in pull-requests.md
PR-URL: https://github.com/nodejs/node/pull/35718
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
| -rw-r--r-- | doc/guides/contributing/pull-requests.md | 18 | ||||
| -rw-r--r-- | doc/guides/onboarding-extras.md | 11 |
2 files changed, 15 insertions, 14 deletions
diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index 84039f89412..c61ac5ff37d 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -35,6 +35,7 @@ so that you can make the actual changes. This is where we will start. * [CI Testing](#ci-testing) * [Waiting Until the Pull Request Gets Landed](#waiting-until-the-pull-request-gets-landed) * [Check Out the Collaborator Guide](#check-out-the-collaborator-guide) + * [Appendix: Subsystems](#appendix-subsystems) ## Dependencies @@ -171,9 +172,9 @@ A good commit message should describe what changed and why. less, and no more than 72 characters) * be entirely in lowercase with the exception of proper nouns, acronyms, and the words that refer to code, like function/variable names - * be prefixed with the name of the changed subsystem and start with an - imperative verb. Check the output of `git log --oneline files/you/changed` to - find out what subsystems your changes touch. + * be prefixed with the name of the changed [subsystem](#appendix-subsystems) + and start with an imperative verb. Check the output of `git log --oneline + files/you/changed` to find out what subsystems your changes touch. Examples: * `net: add localAddress and localPort to Socket` @@ -603,6 +604,17 @@ widely used, so don't be discouraged! If you want to know more about the code review and the landing process, see the [Collaborator Guide][]. +### Appendix: Subsystems + +* `lib/*.js` (`assert`, `buffer`, etc.) +* `build` +* `doc` +* `lib / src` +* `test` +* `tools` + +More than one subsystem may be valid for any particular issue or pull request. + [Building guide]: ../../../BUILDING.md [CI (Continuous Integration) test run]: #ci-testing [Code of Conduct]: https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md diff --git a/doc/guides/onboarding-extras.md b/doc/guides/onboarding-extras.md index 030074093ee..79951a43392 100644 --- a/doc/guides/onboarding-extras.md +++ b/doc/guides/onboarding-extras.md @@ -2,17 +2,6 @@ ## Labels -### Subsystems - -* `lib/*.js` (`assert`, `buffer`, etc.) -* `build` -* `doc` -* `lib / src` -* `test` -* `tools` - -More than one subsystem may be valid for any particular issue or pull request. - ### General * `confirmed-bug`: Bugs you have verified |