Skip to content

Commit

Permalink
doc: add a subsystems header in pull-requests.md
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
PoojaDurgad authored and BethGriggs committed Dec 15, 2020
1 parent 7367e6c commit 0de3f56
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 14 deletions.
18 changes: 15 additions & 3 deletions doc/guides/contributing/pull-requests.md
Expand Up @@ -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

Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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
Expand Down
11 changes: 0 additions & 11 deletions doc/guides/onboarding-extras.md
Expand Up @@ -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
Expand Down

0 comments on commit 0de3f56

Please sign in to comment.