Skip to content

Conversation

@rmenner
Copy link
Contributor

@rmenner rmenner commented Nov 21, 2025

No description provided.

@rmenner rmenner requested a review from a team as a code owner November 21, 2025 22:09
@rmenner rmenner self-assigned this Nov 21, 2025
@sourcery-ai
Copy link

sourcery-ai bot commented Nov 21, 2025

Reviewer's Guide

Updates the pull request template to introduce a more detailed review checklist, including browser and framework testing requirements, while renaming and restructuring the existing checklist section.

Flow diagram for the updated PR review and RC checklist process

flowchart TD
  A["Start: Author opens PR creation page"] --> B["Read updated 'Review Checklist' section in template"]
  B --> C["Confirm update follows 'CONTRIBUTING' guidelines"]
  C --> D["Perform self-review of changes"]
  D --> E["Expand 'RC Checklist' details section"]
  E --> F["Review testing checklist and supporting links"]
  F --> G["Perform browser testing on Android (Chrome, Firefox)"]
  G --> H["Perform browser testing on iOS (Chrome, Firefox, Safari)"]
  H --> I["Perform browser testing on Desktop (Chrome, Firefox, Safari, Edge)"]
  I --> J["Validate linked issues with issue reporting team"]
  J --> K["Review test coverage report"]
  K --> L["Run framework tests using 'Framework playground' (Next React, SvelteKit)"]
  L --> M["Mark all applicable checkboxes in the template"]
  M --> N["Confirm contribution is under Apache 2.0 license"]
  N --> O["Submit Pull Request"]
Loading

File-Level Changes

Change Details Files
Renamed and expanded the PR checklist into a detailed review workflow, including RC testing details and environment coverage expectations.
  • Renamed the generic 'Checklist' section to 'Review Checklist' to clarify its purpose for reviewers and authors.
  • Embedded a collapsible 'RC Checklist' section using HTML
    / to keep the template concise by default while providing expanded guidance when needed.
  • Added a 'Testing Checklist' area that enumerates supported browsers by platform (Android, iOS, Desktop) and aligns expectations with the documented browser support guide.
  • Linked out to an external dev demo URL to centralize where visual/behavioral validation should occur.
  • Introduced scenario-based checks for validating linked issues, reviewing test coverage reports, and exercising the component within the framework playground targets (Next React and SvelteKit).
.github/PULL_REQUEST_TEMPLATE.md

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!

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

Copy link

@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.

Hey there - I've reviewed your changes - here's some feedback:

  • The dev demo link and framework playground URLs are hard-coded to specific Auro resources; consider parameterizing or generalizing these so the template is reusable across different repositories without needing manual edits.
  • Within the new RC Checklist, the heading levels and mixed Markdown/HTML (e.g., ##/### inside <details> plus a trailing <br>) could be simplified for more consistent rendering and accessibility (e.g., avoid the <br> and ensure the heading hierarchy starts at an appropriate level).
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The dev demo link and framework playground URLs are hard-coded to specific Auro resources; consider parameterizing or generalizing these so the template is reusable across different repositories without needing manual edits.
- Within the new RC Checklist, the heading levels and mixed Markdown/HTML (e.g., `##`/`###` inside `<details>` plus a trailing `<br>`) could be simplified for more consistent rendering and accessibility (e.g., avoid the `<br>` and ensure the heading hierarchy starts at an appropriate level).

## Individual Comments

### Comment 1
<location> `.github/PULL_REQUEST_TEMPLATE.md:43` </location>
<code_context>
+
+### Scenarios
+
+- [ ] Validated linked issues with issue reporting team
+- [ ] Test coverage report review
+
</code_context>

<issue_to_address>
**suggestion (typo):** Consider adding "the" for smoother grammar in this checklist item.

For example: “Validated linked issues with the issue reporting team.”

```suggestion
- [ ] Validated linked issues with the issue reporting team
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@github-actions
Copy link

🚀 PR Release Published! v0.0.0-pr66.0

To install:

npm install @aurodesignsystem-dev/[email protected]

Install via alias:

npm install @aurodesignsystem/auro-slideshow@npm:@aurodesignsystem-dev/[email protected]

View on npmjs.com

@rmenner rmenner force-pushed the chore/migration-template-update-reusable branch from 66f6830 to 4baa57f Compare November 22, 2025 00:40
@rmenner rmenner merged commit f4987fe into dev Nov 22, 2025
15 of 20 checks passed
@rmenner rmenner deleted the chore/migration-template-update-reusable branch November 22, 2025 00:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants