Skip to content

Conversation

RayStick
Copy link
Member

@RayStick RayStick commented Sep 8, 2025

The purpose of this PR is to demonstrate the new workflow that automatically generates checklists for the main reviewer and supporting reviewers. These config files are already in the main branch, as this is a testing repo. If we like its functionality, we can implement it across other physiopy repos.

Please see the comments in this PR thread

Addresses physiopy/phys2bids#316

For now, I have tagged all the steering committee members for feedback, but other people are welcome to review this PR as well.

Feedback requested:

  • The text for the main reviewer (see below) - suggest changes as needed
  • The text for the supporting reviewer - suggest changes as needed
  • The functionality of this automation (please attempt to break it)
    • For example, if someone takes themselves off being a reviewer, I think their checklist comment still remains

Added section about automated PR reviewer checklists.
@github-actions github-actions bot added the Documentation This issue or PR is about the documentation label Sep 8, 2025
@RayStick RayStick requested a review from smoia September 8, 2025 13:52
Copy link

github-actions bot commented Sep 8, 2025

Hello @smoia!

You're the first to be be assigned to this PR, which means that you've been nominated Main Reviewer! Lucky you!

As a Main Reviewer, you are slightly more responsible for the quality of this PR than your fellow Reviewers. If you have any doubt, check this section on reviewing and this section on being the Main Reviewer of the documents.

Before merging this PR, please check that:

  • The PR passes all the tetst (e.g. CircleCI/Azure).
  • The content respects the Style Guide.
  • If the PR contains documentation, your local build is right.
  • The PR and the reviews are harmonious with the rest of the repository, especially that they don't introduce repetitions.
  • The title of the PR is clear enough to describe a release content.
  • The labels are correct - and they will (or won't) trigger the correct auto release.
  • The PR received the amount of approvals necessaries to be merged.

If the PR contains code changes:

  • Content and changes are adequately documented in the docstrings.
  • User documentation is being updated accordingly - or a related issue has been opened.
  • The adequate tests have been added/updated - or a related issue has been opened if coverage doesn't drop below 90%.

After you merged this PR, please check that:

  • The Author(s) and Reviewers contributions have been updated in the README.
  • The updates (in code, tests and documentation) have appened correctly.
  • If needed, the tag was created, the release was cut, and the pypi version got updated.

Thank you!

@RayStick RayStick requested a review from m-miedema September 8, 2025 13:53
Copy link

github-actions bot commented Sep 8, 2025

Hello @m-miedema!

You've been assigned to this PR, which means that you've been nominated as reviewer! You are a supporting reviewer, not the main reviewer. The main reviewer has more responsibilities than you (lucky them) but your review is still important.

For a guide, check out this section on reviewing. Please see the checklist that the main reviewer has been given (somewhere above this comment) and consider what support you can provide to them.

Thank you!

Copy link

github-actions bot commented Sep 8, 2025

Hello @goodalse2019!

You've been assigned to this PR, which means that you've been nominated as reviewer! You are a supporting reviewer, not the main reviewer. The main reviewer has more responsibilities than you (lucky them) but your review is still important.

For a guide, check out this section on reviewing. Please see the checklist that the main reviewer has been given (somewhere above this comment) and consider what support you can provide to them.

Thank you!

Copy link

github-actions bot commented Sep 8, 2025

Hello @CesarCaballeroGaudes!

You've been assigned to this PR, which means that you've been nominated as reviewer! You are a supporting reviewer, not the main reviewer. The main reviewer has more responsibilities than you (lucky them) but your review is still important.

For a guide, check out this section on reviewing. Please see the checklist that the main reviewer has been given (somewhere above this comment) and consider what support you can provide to them.

Thank you!

@RayStick RayStick added this to Physiopy Sep 8, 2025
@RayStick RayStick moved this to PR needs review in Physiopy Sep 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation This issue or PR is about the documentation
Projects
Status: PR needs review
Development

Successfully merging this pull request may close these issues.

1 participant