Skip to content

Commit f8d57f9

Browse files
committed
doc: add additional guidance for PRs to deps
- add additional guidance based in discussion related to recent PR to dependency and discussion within the security-wg slack channel. Refs: nodejs/security-wg#1329 Signed-off-by: Michael Dawson <[email protected]>
1 parent 26f2cbd commit f8d57f9

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

doc/contributing/maintaining/maintaining-dependencies.md

+5
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,11 @@ the corresponding script in `tools/update-deps`.
144144
[npm-cli-bot](https://github.com/npm/cli/blob/latest/.github/workflows/create-node-pr.yml)
145145
takes care of npm update, it is maintained by the npm team.
146146

147+
PRs for manual dependency updates should only be accepted if
148+
the update cannot be generated by the automated tooling,
149+
the reason is clearly documented and either the PR is
150+
reviewed in detail or it is from an existing collaborator.
151+
147152
## Dependency list
148153

149154
### acorn

doc/contributing/pull-requests.md

+9
Original file line numberDiff line numberDiff line change
@@ -525,6 +525,15 @@ to fail on specific platforms or for so-called "flaky" tests to fail ("be red").
525525
It is vital to visually inspect the results of all failed ("red") tests to
526526
determine whether the failure was caused by the changes in the pull request.
527527

528+
529+
### Dependencies
530+
531+
Ideally pull requests for dependencies should be generated by automation.
532+
Pay special attention to pull requests for dependencies which have not
533+
been automatically generated and follow the guidance in
534+
[Maintaining Dependencies](https://github.com/nodejs/node/blob/main/doc/contributing/maintaining/maintaining-dependencies.md#updating-dependencies).
535+
536+
528537
## Notes
529538

530539
### Commit squashing

0 commit comments

Comments
 (0)