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.

Sign up for GitHub

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

Jump to bottom

📖 Add reviewing tips #3194

Merged
merged 1 commit into from
Jun 19, 2020
Merged

📖 Add reviewing tips #3194

merged 1 commit into from
Jun 19, 2020

Conversation

fabriziopandini
Copy link
Member

What this PR does / why we need it:
The Cluster API community is vibrant and often new people start sending PRs, or existing contributors starts to review other's PRs.

So, in order to help everyone, I started this document as a collection of review tips/useful infos, so both developers and reviewers can start sharing a common knowledge base about what is important to get properly addressed in a Cluster API PR.

/assign @vincepri @detiber @ncdc @CecileRobertMichon

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jun 15, 2020
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 15, 2020
vincepri
vincepri reviewed Jun 15, 2020
View reviewed changes
docs/reviewing.md Outdated Show resolved Hide resolved
detiber
detiber reviewed Jun 15, 2020
View reviewed changes
reviewing.md Outdated Show resolved Hide resolved
reviewing.md Outdated Show resolved Hide resolved
vincepri
vincepri reviewed Jun 15, 2020
View reviewed changes
reviewing.md Outdated Show resolved Hide resolved
vincepri
vincepri reviewed Jun 15, 2020
View reviewed changes
reviewing.md Outdated Show resolved Hide resolved
@fabriziopandini fabriziopandini mentioned this pull request Jun 15, 2020
Merged
JoelSpeed
JoelSpeed reviewed Jun 16, 2020
View reviewed changes
Copy link
Contributor

@JoelSpeed JoelSpeed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this doc will be very useful for new contributors and reviewers, thanks for the write up. Added a couple of suggestions while reading

REVIEWING.md Outdated Show resolved Hide resolved
REVIEWING.md Outdated Show resolved Hide resolved
REVIEWING.md Outdated Show resolved Hide resolved
CecileRobertMichon
CecileRobertMichon reviewed Jun 16, 2020
View reviewed changes
REVIEWING.md Outdated Show resolved Hide resolved
CecileRobertMichon
CecileRobertMichon reviewed Jun 16, 2020
View reviewed changes
REVIEWING.md Outdated Show resolved Hide resolved
@CecileRobertMichon
Copy link
Contributor

Overall lgtm, 2 minor comments.

This doc will be very useful to have for both reviewers and contributors, thank you for writing it!

@fabriziopandini
Copy link
Member Author

@vincepri @CecileRobertMichon comments addressed
I have removed general review tips and added a logging section with two useful links

@fabriziopandini
Copy link
Member Author

/test pull-cluster-api-e2e

wfernandes
wfernandes reviewed Jun 18, 2020
View reviewed changes
Copy link
Contributor

@wfernandes wfernandes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor nits

REVIEWING.md Outdated Show resolved Hide resolved
REVIEWING.md Outdated Show resolved Hide resolved
REVIEWING.md Outdated Show resolved Hide resolved
@vincepri vincepri removed the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 18, 2020
@vincepri
Copy link
Member

/hold

Just holding for lazy consensus until tomorrow

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 18, 2020
@vincepri
Copy link
Member

@fabriziopandini given that the other PR has merged, can we add a link to this document from the contributing guide?

@detiber
Copy link
Member

detiber commented Jun 19, 2020

/lgtm
/hold cancel
canceling hold since lazy consensus period has passed and there have been no objections

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Jun 19, 2020
vincepri
vincepri approved these changes Jun 19, 2020
View reviewed changes
Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 19, 2020
@k8s-ci-robot k8s-ci-robot merged commit 31d84b1 into kubernetes-sigs:master Jun 19, 2020
@fabriziopandini fabriziopandini deleted the reviewing-tips branch June 19, 2020 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JoelSpeed JoelSpeed JoelSpeed left review comments

@CecileRobertMichon CecileRobertMichon CecileRobertMichon left review comments

@wfernandes wfernandes wfernandes left review comments

@detiber detiber detiber left review comments

@vincepri vincepri vincepri approved these changes

Assignees

@ncdc ncdc

@detiber detiber

@vincepri vincepri

@CecileRobertMichon CecileRobertMichon

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@fabriziopandini @CecileRobertMichon @vincepri @detiber @k8s-ci-robot @wfernandes @JoelSpeed @ncdc