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

Clarify the pull request review guidance for company diversity #1097

Merged
merged 1 commit into from
Dec 14, 2023

Conversation

jerop
Copy link
Member

@jerop jerop commented Oct 25, 2023

As discussed at the governance/community meeting on 25/10, we clarify the guidance on company diversity for reviews. This update upholds that company diversity is an important recommendation but that maintainers have discretion to make exceptions after careful review of the changes.

Note that the policy for TEPs is different: a TEP must be approved by at least two owners from different companies

cc @wlynch @dibyom @pritidesai @tektoncd/governing-board

@tekton-robot tekton-robot requested review from dibyom and wlynch October 25, 2023 18:27
@tekton-robot tekton-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Oct 25, 2023
process/README.md Outdated Show resolved Hide resolved
@jerop jerop force-pushed the clarify-pr-diversity branch from 3f84a19 to 68b9e73 Compare October 25, 2023 19:41
@tekton-robot tekton-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 25, 2023
@jerop jerop force-pushed the clarify-pr-diversity branch from 68b9e73 to 41e0da0 Compare October 25, 2023 19:43
@jerop jerop requested a review from wlynch October 25, 2023 19:43
Copy link
Member

@QuanZhang-William QuanZhang-William left a comment

Choose a reason for hiding this comment

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

Thanks for this update. This update looks good to me!

(and I think we are already strictly following the TEP review rules as well).

process/README.md Outdated Show resolved Hide resolved
@jerop jerop force-pushed the clarify-pr-diversity branch 2 times, most recently from be0b1c0 to 9c8d57a Compare October 25, 2023 20:02
@jerop
Copy link
Member Author

jerop commented Oct 25, 2023

and I think we are already strictly following the TEP review rules as well.

Yes, the policy for TEPs is different: a TEP must be approved by at least two owners from different companies

@pritidesai
Copy link
Member

This update upholds that company diversity is an important recommendation that should be observed
when appropriate, not a policy that is applied to all pull requests.

Have we seen company diversity recommendation applying to all pull requests?

We rely on maintainer discretion to determine when appropriate.

What is the best practice for the maintainers?

Is introducing almost 4000 lines of code with about 7 or 8 comments appropriate?

This is to ensure that we don't further slow down reviews in the project
when we have already gathered diverse input on the change in a TEP, or
the change is minor and reversible.

TEP only covers design proposal of a new feature. TEP does not cover how implementing that new feature can impact an existing functionality. This is generally discovered during an implementation phase. Not all functionalities are 100% covered by the automated tests and that's where reviewers play a key role in identifying any discrepancies.

@jerop
Copy link
Member Author

jerop commented Oct 26, 2023

This PR is a call for input and I encourage anyone to contribute wording that gets us to a place of clarity about our processes

This update upholds that company diversity is an important recommendation that should be observed
when appropriate, not a policy that is applied to all pull requests.

Have we seen company diversity recommendation applying to all pull requests?

What I have seen is contributors now worried about company diversity slowing down their pull requests, and even one considering writing one big pull request so that the delay doesn't add up across many small pull requests, so I wanted to ensure that it's not mistakenly interpreted to mean that we need to observe this guidance for all changes going forward

Is introducing almost 4000 lines of code with about 7 or 8 comments appropriate?

If you're referring to tektoncd/pipeline#7260, most of the lines of code were generated -- we are happy to address any feedback on the changes or revert the pull request if you'd like -- or was it another pull request?

Discretion will not always be the same among maintainers, I take ownership of any slip up in PRs I approved

TEP only covers design proposal of a new feature. TEP does not cover how implementing that new feature can impact an existing functionality. This is generally discovered during an implementation phase. Not all functionalities are 100% covered by the automated tests and that's where reviewers play a key role in identifying any discrepancies.

Agreed, that's why maintainers need to interpret when it's appropriate to gather more input, and it won't be perfect

Just trying to prevent a wrong interpretation of this guidance that will further slow down velocity in the project

process/README.md Outdated Show resolved Hide resolved
@jerop jerop force-pushed the clarify-pr-diversity branch from 9c8d57a to ec9698b Compare October 26, 2023 14:01
@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 26, 2023
@pritidesai
Copy link
Member

If you're referring to tektoncd/pipeline#7260, most of the lines of code were generated -- we are happy to address any feedback on the changes or revert the pull request if you'd like -- or was it another pull request?

There has been many such PRs and that's the reason the guidelines were agreed on and put in place with #829 after a discussion with the community.

I am personally not advocating for reverting any changes introduced by tektoncd/pipeline#7260. The company policy was only raised here in this PR (introducing about 1900 lines of generated code out of 3800) to make sure other maintainers get an opportunity to review a very significant concept of the project which was merged under 48 hours.

We all are experiencing the velocity issue because of the lack of enforcement of reviewing PRs as they are opened. There are many factors contributing to such behavior - lack of topical ownership being the biggest.

We have been doing fairly good when PRs are part of a milestone and we should make that official if its not already to help with the velocity.

As discussed at the governance/community meeting on 25/10, we clarify
the guidance on company diversity for reviews. This update upholds that
company diversity is an important recommendation but that maintainers
have discretion to make exceptions after careful review of the changes.
@jerop jerop force-pushed the clarify-pr-diversity branch from ec9698b to c016f41 Compare October 27, 2023 19:32
Copy link
Member

@afrittoli afrittoli left a comment

Choose a reason for hiding this comment

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

Thanks @jerop - this looks good to me.
/approve

@dibyom
Copy link
Member

dibyom commented Nov 27, 2023

/approve

@tekton-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: afrittoli, dibyom, vdemeester

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:
  • OWNERS [afrittoli,dibyom,vdemeester]

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

@jerop
Copy link
Member Author

jerop commented Nov 30, 2023

Can we please merge this? 🙏🏾

@vdemeester
Copy link
Member

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Dec 14, 2023
@tekton-robot tekton-robot merged commit e870d6d into tektoncd:main Dec 14, 2023
@jerop jerop deleted the clarify-pr-diversity branch December 14, 2023 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants