doc: add large pull requests contributing guide#62829
doc: add large pull requests contributing guide#62829mcollina wants to merge 2 commits intonodejs:mainfrom
Conversation
|
Review requested:
|
There was a problem hiding this comment.
- We should link to it from CONTRIBUTING.md, pull-requests.md, collaborator-guide.md (or some subset of those)
- We should exclude routine dependency/wpt/test bot-issued PRs, this can either be excluded explicitly with additional rules or by changing the classification put forth by the
OvervieworWhat qualifies as a large pull requestsections - dependency changes in a separate commit is at odds with having each commit self-contained, this is fine when the commits get squashed but the first commit's message is used for the squash so the first commit would be the non-deps changes? seems odd and counter-intuitive
- Design document - I 100% discourage linking outside documents, a detailed PR description should also suffice, 3000 can easily be hit with just thorough test coverage for an otherwise trivial change, how would a design document help such PRs?
- Both
Separating test additions from implementation changes.andSplitting documentation into its own pull request.strategies to avoiding large PRs are contrary to what we usually request of contributions. Those strategies only work when the contribution isn't "done" or "shipped" and is excluded from builds.
- Exclude routine dependency/WPT/bot PRs from the policy - Replace design document requirement with detailed PR description - Clarify dependency commit ordering for squash landing - Remove splitting strategies that contradict self-contained PRs - Add links from CONTRIBUTING.md, pull-requests.md, collaborator-guide.md Signed-off-by: Matteo Collina <matteo.collina@gmail.com>
e9d9a4c to
7552c50
Compare
|
|
||
| Large pull requests follow the same approval path as semver-major changes: | ||
|
|
||
| * At least **two TSC member approvals** are required. |
There was a problem hiding this comment.
Can we enforce commit-queue bot to check this?
There was a problem hiding this comment.
Is this a blocker for this landing?
|
The specification here doesn't seem very clear:
|
We have to draw a line, and this is as good as any. I proposed 5k but I was asked to lower it. I would be happier with a 3k of non-test/non-doc changes, but that would require better tooling, which I'd prefer to avoid creating now. What would work for you?
The number that matters is at landing time. |
In the document it says: So
I would say as soon as it reaches the threshold the new rules apply. This also means that if with further commits the PR shrinks, rules do not apply anymore. |
Fixes: #62752
Adds a contributing guide for large pull requests (3000+ lines), covering: