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

[HowTo] Conduct a PR review #6

Open
peternied opened this issue Oct 7, 2022 · 0 comments
Open

[HowTo] Conduct a PR review #6

peternied opened this issue Oct 7, 2022 · 0 comments

Comments

@peternied
Copy link
Owner

One line at a time 😄

For breaking in on a big pull request,

  • First I'd never skip reading the PR description

  • Then I'd read all the comments other people put on the review

  • Then I would try to find the the root of the change, This one is a good example, if you look at commits over time you can see how things shifted from one file to many locations Log deprecation message on legacy ldap pool settings opensearch-project/security#2099

  • Then try to find patterns, that code review actually has many pattern that get 'simplier' once you get more familiar.

  • Last component - figure out what 'stage' of review the code is in. You want to provide the hardest to correct feedback first starting with data flow design, onto interfaces/parameters, duplicated functionality, maintainability/hard to understand sections, style, and finally tooling (CI failures).

If you show up early to a review you can touch any of those aspects without concern since the code / contributor is fresh, if you are later, be more sparing with feedback. But always feel free to ask questions.

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

No branches or pull requests

1 participant