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

PR Review standards #130

Closed
jakirkham opened this issue May 10, 2016 · 2 comments
Closed

PR Review standards #130

jakirkham opened this issue May 10, 2016 · 2 comments

Comments

@jakirkham
Copy link
Member

This has come up in a few places and I think it would be helpful to have a discussion somewhere. So, I have opened this issue. Feel free to add any thoughts you would like here.

@jakirkham
Copy link
Member Author

Some discussion points came up in the hackpad I am adding them here with some points that came to mind so that I don't forget them.

  • Treat every PR as a Work in Progress. At least let PRs sit for a few hours before merging them.
    • It is very tricky with so many PRs to tell their importance or state. While waiting for a few hours seems fine. Maybe we can take a look at some other organizational strategies that will keep us from stepping on each others toes. One thing to consider might be how scikit-learn approaches this problem. They suggest adding WIP to PRs still being worked on, MRG to PRs that are ready for thorough review, and MRG+1 to PRs that have been reviewed and have at least one LGTM. ( https://github.com/scikit-learn/scikit-learn/blob/master/CONTRIBUTING.md#contributing-pull-requests )
  • Wait for answers when we ask clarification questions and avoid acting before we have them.
    • Not sure where this came up, but some thoughts here might include documenting a checklist of todos/open questions, concerns, and other unresolved issues as is done in this PR ( conda forge/staged recipes#370 ).
  • Respect the first reviewer by not repeating her/his review comments with another words. That is also bad for the person submitting the PR as it is confusing.
    • Not sure if I exactly understand this point as written, but I believe this means don't repeat something that people agree with. Maybe we can opt for using the 👍 button to just agree to keep things simple. If this is related to points of disagreement as well, please see the point below (tldr documented standards that we agree on avoids having disagreements on every change).
  • Avoid the death by a thousand cuts: Many small "nit" comments that might scare new contributors ( ping Mike S ;-)

@ocefpaf
Copy link
Member

ocefpaf commented May 10, 2016

I added the topics to the next meeting agenda and I would like to discuss there first. before opening any issue here or anywhere. I'd appreciate if you could understand that @jakirkham as there are sensitive issues I want to bring that are not appropriate for discussion here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants