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

Add issue templates for component blueprint and publishing process #388

Merged
merged 1 commit into from
Mar 4, 2025

Conversation

rmenner
Copy link
Contributor

@rmenner rmenner commented Mar 4, 2025

Alaska Airlines Pull Request

Before Submitting this pull request:

  • Link all tickets in this repository related to this PR in the Development section
    note: all pull requests require at least one linked ticket
  • If this PR is Ready For Review, all ticket's linked under Development must have their status changed to Ready For Review as well

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I have performed a self-review of my own update.

Summary by Sourcery

Adds issue templates for component blueprints and the component publishing process to standardize and streamline these processes.

New Features:

  • Adds an issue template for component blueprints, including sections for anatomy, color, typography, layout, spacing, animation/behavior, variants, states, and accessibility.
  • Adds an issue template for the component publishing process, including sections for design & planning, development, documentation, testing, review, and publishing.

@rmenner rmenner self-assigned this Mar 4, 2025
@rmenner rmenner requested a review from a team as a code owner March 4, 2025 02:16
Copy link

sourcery-ai bot commented Mar 4, 2025

Reviewer's Guide by Sourcery

This pull request adds two new issue templates to the repository. The first template is for publishing components to the Auro Design System, and the second template is for creating component blueprints. These templates provide checklists to ensure that all necessary steps are completed and standards are met.

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

File-Level Changes

Change Details Files
Added a new issue template for publishing components to the Auro Design System.
  • Created a checklist to ensure all necessary steps are completed before publishing a component.
  • The checklist includes sections for design and planning, development, documentation, testing, review, and publishing.
  • Each section contains specific tasks to verify compliance with Auro Design System standards.
.github/ISSUE_TEMPLATE/publish_component.md
Added a new issue template for creating component blueprints.
  • Created a checklist to guide the creation of new component blueprints.
  • The checklist includes sections for anatomy, color, typography, layout, spacing, animation/behavior, variants, states, and accessibility.
  • Optional sections for competitive analysis, research, site audit, and usage audit are also included.
.github/ISSUE_TEMPLATE/blueprint.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!
  • 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

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 @rmenner - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a brief explanation of when each issue template should be used.
  • It might be helpful to include instructions on how to use the templates.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

@rmenner rmenner merged commit f059fbf into main Mar 4, 2025
3 of 5 checks passed
@rmenner rmenner deleted the rmenner/release-edit branch March 4, 2025 02:19
@jason-capsule42
Copy link
Member

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@jason-capsule42 jason-capsule42 added the released Completed work has been released label Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants