Skip to content

Commit c13600f

Browse files
mhdawsonmarco-ippolito
authored andcommitted
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]> PR-URL: #53499 Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Ulises Gascón <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Richard Lau <[email protected]>
1 parent f325c54 commit c13600f

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

doc/contributing/collaborator-guide.md

+5
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,11 @@ for the change.
127127

128128
Approval must be from collaborators who are not authors of the change.
129129

130+
Ideally pull requests for dependencies should be generated by automation.
131+
Pay special attention to pull requests for dependencies which have not
132+
been automatically generated and follow the guidance in
133+
[Maintaining Dependencies](https://github.com/nodejs/node/blob/main/doc/contributing/maintaining/maintaining-dependencies.md#updating-dependencies).
134+
130135
In some cases, it might be necessary to summon a GitHub team to a pull request
131136
for review by @-mention.
132137
See [Who to CC in the issue tracker](#who-to-cc-in-the-issue-tracker).

doc/contributing/maintaining/maintaining-dependencies.md

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

145+
PRs for manual dependency updates should only be accepted if
146+
the update cannot be generated by the automated tooling,
147+
the reason is clearly documented and either the PR is
148+
reviewed in detail or it is from an existing collaborator.
149+
150+
In general updates to dependencies should only be accepted
151+
if they have already landed in the upstream. The TSC may
152+
grant an exception on a case-by-case basis. This avoids
153+
the project having to float patches for a long time and
154+
ensures that tooling can generate updates automatically.
155+
145156
## Dependency list
146157

147158
### acorn

0 commit comments

Comments
 (0)