Skip to content

chore(Template): update PR template #5559

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
Merged
merged 2 commits into from
Mar 7, 2025
Merged

chore(Template): update PR template #5559

merged 2 commits into from
Mar 7, 2025

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Mar 7, 2025 •
edited
Loading

Link issues

fixes #5558

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Mar 7, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request updates the pull request template by adding comments to guide users on how to fill in each section and removing redundant hyphens from checklist items.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated the pull request template to include comments that provide instructions for each section.
  • Added comments to the 'Link issues' section to provide instructions on how to fill in the relevant issue number.
  • Added comments to the 'Regression?' section to provide instructions on specifying the version the behavior has regressed from.
  • Added comments to the 'Risk' section to provide instructions on justifying the selection.
  • Removed redundant hyphens from checklist items to improve readability.
 .github/pull_request_template.md

Assessment against linked issues

Issue Objective Addressed Explanation
#5558 Update the pull request template. ✅

Possibly linked issues

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the chore This are tasks or bot action label Mar 7, 2025
@bb-auto bb-auto bot added this to the v9.4.0 milestone Mar 7, 2025
sourcery-ai[bot]
sourcery-ai bot reviewed Mar 7, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We encountered an error and are unable to review this PR. We have been notified and are working to fix it.

You can try again by commenting this pull request with @sourcery-ai review, or contact us for help.

@ArgoZhang
Copy link
Member Author

ArgoZhang commented Mar 7, 2025

@sourcery-ai review

@ArgoZhang ArgoZhang merged commit 815207c into main Mar 7, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the chore-template branch March 7, 2025 02:28
@codecov
Copy link

codecov bot commented Mar 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6d8ca20) to head (99d3a1d).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main     #5559   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          649       649           
  Lines        29605     29605           
  Branches      4172      4172           
=========================================
  Hits         29605     29605

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

@ArgoZhang ArgoZhang

Labels

chore This are tasks or bot action

Projects

None yet

Milestone

v9.4.0

Development

Successfully merging this pull request may close these issues.

chore(Template): update PR template

2 participants

@ArgoZhang