Skip to content

Commit 6513a58

Browse files
PoojaDurgadtargos
authored andcommitted
doc: add a subsystems header in pull-requests.md
PR-URL: #35718 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
1 parent 52a77db commit 6513a58

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

doc/guides/contributing/pull-requests.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ so that you can make the actual changes. This is where we will start.
3535
* [CI Testing](#ci-testing)
3636
* [Waiting Until the Pull Request Gets Landed](#waiting-until-the-pull-request-gets-landed)
3737
* [Check Out the Collaborator Guide](#check-out-the-collaborator-guide)
38+
* [Appendix: Subsystems](#appendix-subsystems)
3839

3940
## Dependencies
4041

@@ -171,9 +172,9 @@ A good commit message should describe what changed and why.
171172
less, and no more than 72 characters)
172173
* be entirely in lowercase with the exception of proper nouns, acronyms, and
173174
the words that refer to code, like function/variable names
174-
* be prefixed with the name of the changed subsystem and start with an
175-
imperative verb. Check the output of `git log --oneline files/you/changed` to
176-
find out what subsystems your changes touch.
175+
* be prefixed with the name of the changed [subsystem](#appendix-subsystems)
176+
and start with an imperative verb. Check the output of `git log --oneline
177+
files/you/changed` to find out what subsystems your changes touch.
177178

178179
Examples:
179180
* `net: add localAddress and localPort to Socket`
@@ -603,6 +604,17 @@ widely used, so don't be discouraged!
603604
If you want to know more about the code review and the landing process, see the
604605
[Collaborator Guide][].
605606

607+
### Appendix: Subsystems
608+
609+
* `lib/*.js` (`assert`, `buffer`, etc.)
610+
* `build`
611+
* `doc`
612+
* `lib / src`
613+
* `test`
614+
* `tools`
615+
616+
More than one subsystem may be valid for any particular issue or pull request.
617+
606618
[Building guide]: ../../../BUILDING.md
607619
[CI (Continuous Integration) test run]: #ci-testing
608620
[Code of Conduct]: https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md

doc/guides/onboarding-extras.md

-11
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,6 @@
22

33
## Labels
44

5-
### Subsystems
6-
7-
* `lib/*.js` (`assert`, `buffer`, etc.)
8-
* `build`
9-
* `doc`
10-
* `lib / src`
11-
* `test`
12-
* `tools`
13-
14-
More than one subsystem may be valid for any particular issue or pull request.
15-
165
### General
176

187
* `confirmed-bug`: Bugs you have verified

0 commit comments

Comments
 (0)