Skip to content

DOC: add 2 review policy for large doc PRs - #32113

Merged
ksunden merged 1 commit into
matplotlib:mainfrom
story645:doc-2=review
Aug 7, 2026
Merged

DOC: add 2 review policy for large doc PRs#32113
ksunden merged 1 commit into
matplotlib:mainfrom
story645:doc-2=review

Conversation

@story645

@story645 story645 commented Jul 24, 2026

Copy link
Copy Markdown
Member

PR summary

Our reasoning for two approvals is "This two-pairs-of-eyes strategy shall ensure a consistent project direction and prevent accidental mistakes. It is permissible to merge with one approval if the change is not fundamental and can easily be reverted at any time in the future."

Adding large new sections, adding a lot of new files, major structural changes, etc, all have the same concern of "project direction" and have a higher maintenance cost than small/medium doc PRs because it's a lot of additional material that we have to make sure stays in date, cohesive, discoverable, etc. So I think large doc changes should also get 2 approvals b/c large docs PRs have the same concerns that motivate the 2 review policy for code. If we adopt this policy, large doc PRs can then also be championed.

This PR is very much motivated by the conversation in #29124.

AI Disclosure

nopes

PR checklist

@github-actions github-actions Bot added the Documentation: devdocs files in doc/devel label Jul 24, 2026
@story645 story645 added the status: needs comment/discussion needs consensus on next step label Jul 24, 2026
@tacaswell

Copy link
Copy Markdown
Member

We do not need additional policy for this.

@story645

story645 commented Jul 24, 2026

Copy link
Copy Markdown
Member Author

We do not need additional policy for this.

Why not? Going down the line on the reasoning behind two reviews:

  • consistent project direction - large documentation changes can shape the direction of the docs, which is part of the project
  • prevent accidental mistakes - more room for mistakes when the PR is large
  • change is not fundamental - large doc changes can introduce fundamental changes to the docs
  • can easily be reverted at any time in the future - large changes, especially when there are large moves or additions - are harder to revert, especially if those docs have been changed subsequently

We require 2 reviews on code that's much lower impact.

@story645 story645 changed the title POL: 2 review policy for large doc PRs DOC: add 2 review policy for large doc PRs Jul 24, 2026
@timhoffm

timhoffm commented Jul 24, 2026

Copy link
Copy Markdown
Member

I would side with @story645 here. This is not a new policy. It's a corrolary in the spirit of our policy. We want to have reasonable agreement and thorough thoughts for large-scale doc restructuring. That does not happen often which is why we had generally declared doc changes as a one-pair-of-eyes case. I'm not sure whether we need to spell everything out explicitly, but I would say the new wording is more precise.

@scottshambaugh

scottshambaugh commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

I'm personally of the opinion that 2-review is already burdensome, and that we would benefit from a process of single-maintainer code review on anything that's not hard to change (ie, everything except public API and major architecture). Leaning more towards a merge-and-iterate philosophy. Docs would definitely fall under that.

But in terms of codifying standing policy, I'm fine with this PR.

@story645

story645 commented Aug 5, 2026

Copy link
Copy Markdown
Member Author

ie, everything except public API and major architecture

I think very large doc changes are equally a pain to undo; like roughly equivalent to major architecture changes in how much of the docs it impacts and how much work it takes to unwind/clean up.

But I also agree w/ you in terms of loosening the review requirements on simpler code PRs where the CI should be a good enough check (stuff like bugfixes). Basically I think there should be parity in how code and docs are treated/evaluated since they have about equivalent maintainance burden.

@tacaswell

Copy link
Copy Markdown
Member

I agree this is being more explicit about what was already implicit.

@story645 story645 removed the status: needs comment/discussion needs consensus on next step label Aug 6, 2026
@ksunden ksunden added status: needs comment/discussion needs consensus on next step and removed status: needs comment/discussion needs consensus on next step labels Aug 7, 2026
@ksunden
ksunden merged commit 0607d32 into matplotlib:main Aug 7, 2026
33 of 35 checks passed
@story645
story645 deleted the doc-2=review branch August 7, 2026 19:30
@QuLogic QuLogic added this to the v3.12.0 milestone Aug 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation: devdocs files in doc/devel

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants