Skip to content

added review a PR guide#8258

Merged
shuyama1 merged 4 commits into
GoogleCloudPlatform:mainfrom
shuyama1:review_a_pr
Jul 10, 2023
Merged

added review a PR guide#8258
shuyama1 merged 4 commits into
GoogleCloudPlatform:mainfrom
shuyama1:review_a_pr

Conversation

@shuyama1

@shuyama1 shuyama1 commented Jul 1, 2023

Copy link
Copy Markdown
Member

fixes b/288626199

Screenshot 2023-07-05 at 11 13 55 AM

If this PR is for Terraform, I acknowledge that I have:

  • Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
  • Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).
  • Generated Terraform providers, and ran make test and make lint in the generated providers to ensure it passes unit and linter tests.
  • Ran relevant acceptance tests using my own Google Cloud project and credentials (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
  • Read Write release notes before writing my release note below.

Release Note Template for Downstream PRs (will be copied)


@modular-magician

Copy link
Copy Markdown
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

@modular-magician

Copy link
Copy Markdown
Collaborator

Tests analytics

Total tests: 2834
Passed tests 2538
Skipped tests: 295
Affected tests: 1

Action taken

Found 1 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
TestAccComputeFirewallPolicyRule_multipleRules

Get to know how VCR tests work

@modular-magician

Copy link
Copy Markdown
Collaborator

Tests failed during RECORDING mode:
TestAccComputeFirewallPolicyRule_multipleRules[Error message] [Debug log]

Please fix these to complete your PR
View the build log or the debug log for each test

@shuyama1
shuyama1 requested a review from rileykarson July 5, 2023 18:16
@modular-magician

Copy link
Copy Markdown
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

Comment thread docs/content/contribute/review-pr.md Outdated
weight: 11
---

# Review a PR

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

There are different expectations for maintainer and contributor PRs (self-service / community), should we call them out separately in some way? In particular I'm thinking of:

  • I don't give more than a passing glance to release notes for a maintainer PR, and trust they've written them correctly. For contributor PRs I've got to author them myself.
  • For contributors I've got to wait until all tests are green until clicking approve. For maintainers, I'm generally fine approving if I'm satisfied with the code as-written and tests are most of the way (80-90%) there, even if they're currently failing.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I agree that we have different expectations for maintainer and contributor PRs, but I think this review guide is more like a general checklist that users/ reviewers should follow to (self-)review a PR. We should have all these boxes checked before merging a PR no matter it's a maintainer or contributor PR. Although for maintainer PRs, it's more like the PR author's responsibility to ensure all these steps have been checked. I could call out that that it's author's responsibility (or whoever click the merge button) to ensure that the PR passed all the checks on this list for maintainer PRs. What's your thought?

@melinath melinath Jul 10, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

FWIW I would prefer not to call out that we might have separate standards for maintainers since that is not relevant to most of the people who would read this page and might confuse folks

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ehh, fair enough- the page is doing double-duty as a maintainer and contributor guide in that case, which may leave ambiguities for maintainers.

Comment thread docs/content/contribute/review-pr.md Outdated
Comment thread docs/content/contribute/review-pr.md Outdated
Comment thread docs/content/contribute/review-pr.md Outdated
Comment thread docs/content/contribute/review-pr.md Outdated
@modular-magician

Copy link
Copy Markdown
Collaborator

Tests analytics

Total tests: 2836
Passed tests 2540
Skipped tests: 295
Affected tests: 1

Action taken

Found 1 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
TestAccComputeFirewallPolicyRule_multipleRules

Get to know how VCR tests work

@modular-magician

Copy link
Copy Markdown
Collaborator

Tests failed during RECORDING mode:
TestAccComputeFirewallPolicyRule_multipleRules[Error message] [Debug log]

Please fix these to complete your PR
View the build log or the debug log for each test

@shuyama1

Copy link
Copy Markdown
Member Author

updated version:
Screenshot 2023-07-09 at 11 46 45 PM

@shuyama1
shuyama1 requested a review from rileykarson July 10, 2023 06:49
@modular-magician

Copy link
Copy Markdown
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

@modular-magician

Copy link
Copy Markdown
Collaborator

Tests analytics

Total tests: 2847
Passed tests 2550
Skipped tests: 295
Affected tests: 2

Action taken

Found 2 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
TestAccComputeFirewallPolicyRule_multipleRules|TestAccContainerAwsNodePool_BetaBasicHandWritten

Get to know how VCR tests work

@modular-magician

Copy link
Copy Markdown
Collaborator

$\textcolor{red}{\textsf{Tests failed during RECORDING mode:}}$
TestAccComputeFirewallPolicyRule_multipleRules[Error message] [Debug log]
TestAccContainerAwsNodePool_BetaBasicHandWritten[Error message] [Debug log]

$\textcolor{red}{\textsf{Please fix these to complete your PR.}}$
View the build log or the debug log for each test

@rileykarson

Copy link
Copy Markdown
Member

Any thoughts on different responsibilities as mentioned in #8258 (comment)?

@shuyama1
shuyama1 merged commit c5e12b3 into GoogleCloudPlatform:main Jul 10, 2023
@shuyama1
shuyama1 deleted the review_a_pr branch July 10, 2023 20:43
baskaran-md pushed a commit to baskaran-md/magic-modules that referenced this pull request Jul 10, 2023
Khaledmohamedrefaat pushed a commit to Khaledmohamedrefaat/magic-modules that referenced this pull request Jul 13, 2023
ericayyliu pushed a commit to ericayyliu/magic-modules that referenced this pull request Jul 26, 2023
wj-chen pushed a commit to wj-chen/magic-modules that referenced this pull request Aug 1, 2023
hao-nan-li pushed a commit to hao-nan-li/magic-modules that referenced this pull request Aug 9, 2023
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

Successfully merging this pull request may close these issues.

4 participants