Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move to having two reviewers for pull requests? #350

Open
dstansby opened this issue Apr 3, 2024 · 6 comments · May be fixed by #473
Open

Move to having two reviewers for pull requests? #350

dstansby opened this issue Apr 3, 2024 · 6 comments · May be fixed by #473
Assignees
Labels
task A task to be completed with the repo

Comments

@dstansby
Copy link
Member

dstansby commented Apr 3, 2024

What needs to be done?

Now we have a pretty established package and set of docs, I was wondering what people think of going up from requiring one approval to two approvals on pull requests? My thinking is that:

  • It would give a second pair of eyes on stuff to make sure anything we add to the docs has slightly wider agreement
  • Getting other folks to review/approve changes or additions to the docs might be a nice low-effort/low barrier to entry way of getting more people involved in this project?

It would slow down how fast things are merged, but I think that the project as a whole is now mature enough that that shouldn't be too much of an issue.

Thoughts?

@dstansby dstansby added the task A task to be completed with the repo label Apr 3, 2024
@paddyroddy
Copy link
Member

I like this idea. However, I very rarely miss a notification, which may not be the case for others. Being blocked when you have a 1 review and awaiting a 2nd can be frustrating.

@samcunliffe
Copy link
Member

samcunliffe commented Apr 3, 2024

I'm 👍 to this idea. Two members or associate members?

Perhaps after we've tagged "v1" of our template and the repo is citable, etc...?

@paddyroddy
Copy link
Member

I'm actually against this. This morning (until @matt-graham) arrived, we only had 2 of us. Plus, people often take ages to review, so it will make it hard to get stuff merged.

@samcunliffe
Copy link
Member

Notes from hackmorning 2024-10-22

Discussion

There is a bit of a distinction between opinionated changes (i.e. changes to the traffic lights and default tools in the template) vs infrastructure fixes, linting, or fixes to tests.

The CONTRIBUTING guide currently (df14157) says:

The website pages are open to contributions but they will need to be reviewed by a member or associate member of ARC. We might be slow to approve new tool suggestions (since we'll probably want to discuss them first) but don't let that put you off creating an issue.

Our quick zoom around rulesets doesn't seem that we could have a per-directory rule. (2 reviewers for docs/ and only one reviewer for everywhere else.)

There hasn't yet really been any change that was close to controversial that made it to the repo before a long discussion in issues. Maybe this is not such a problem.

Decisions

We will have a common-sense policy: two reviewers if you think it's something potentially controversial like changing a traffic light. One reviewer otherwise. This is not enforced but included in CONTRIBUTING. @UCL-ARC/collaborations-python-tooling can be used for "the second" reviewer.

@samcunliffe samcunliffe self-assigned this Oct 22, 2024
@dstansby
Copy link
Member Author

Happy to stick with this for now - I do think there's a bit of a chicken and egg situtation though. If we only require one reviewer, the more regular reviewers on this repo will review and merge everything, thus not encouraging others to join in and review, thus reducing the reviewer pool so that we are worried that requiring two reviewers means stuff isn't merged.

I personally think the benefit of encouraging new maintainers in this repo outweighs the downside of sometimes having to wait a bit for review, and I don't think this is a repo where we have to merge stuff immediately and develop fast. Indeed, I think it's much more important to have consensus (even on seemingly small infastrcuture changes) than merge stuff fast.

Happy to go with the above though, thanks for discussing and documenting that! 👍

One suggestion I would make is that the first reviewer is allowed to request a second reviewer, and the author should respect that decision?

samcunliffe added a commit that referenced this issue Oct 22, 2024
@samcunliffe samcunliffe linked a pull request Oct 22, 2024 that will close this issue
@samcunliffe samcunliffe linked a pull request Oct 22, 2024 that will close this issue
@paddyroddy
Copy link
Member

I've also made an issue label needs-2-reviewers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
task A task to be completed with the repo
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants