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

KRA 2093 add writing icons #1713

Merged
merged 2 commits into from
Dec 4, 2024
Merged

KRA 2093 add writing icons #1713

merged 2 commits into from
Dec 4, 2024

Conversation

michaelglass
Copy link
Contributor

@michaelglass michaelglass commented Dec 4, 2024

🌟 Adding new writing icons for guided essays & guided short response

About the component

https://linear.app/noredink/issue/KRA-2093/add-guided-essay-and-guided-short-response-icons-to-noredink-ui

🖼️ What does this change look like?

CleanShot 2024-12-04 at 11 52 32@2x

Component completion checklist

  • I've gone through the relevant sections of the Development Accessibility guide with this component in mind
  • Component has clear documentation
  • Component is in the Component Catalog
    • I've used the script to add the component to the Component Catalog.
    • Component is categorized reasonably (see Category for all the currently available categories). The component can be in multiple categories, if appropriate.
    • Component has a representative preview for the Component Catalog cards (bonus points for making it delightful!)
    • Component has a customizable example. Aim for having every possible supported version of the component displayable through the configuration on this page. (Protip: This is handy for testing expected behavior!)
    • The customizable example produces sample code
    • The component's example page includes keyboard behavior, if any
    • The component's example page includes guidance around how to use the component, if necessary
  • Component is tested
    • axe checks and percy snapshots will be automatically added for every component. However, if you want to customize when the checks and snapshots are made, you will need to make changes to script/puppeteer-tests.js.
    • there are 2 ways to add Elm tests:
      • if you want to test the Component Catalog example directly, add ProgramTest-style tests under component-catalog/tests
      • if you want to test the component directly, add tests under tests/Spec. Historically, this has been the more popular Elm testing strategy for noredink-ui.
  • Component API follows standard patterns in noredink-ui
    • e.g., as a dev, I can conveniently add an nriDescription
    • and adding a new feature to the component will not require major API changes to the component
  • Please assign the following reviewers:
    • Someone from your team who can review your PR in full and review requirements from your team's perspective.
    • Component library owner - Someone from this group will review your PR for accessibility and adherence to component library foundations.
    • If there are user-facing changes, a designer. (You may want to direct your designer to the deploy preview for easy review):
      • For writing-related component changes, add Stacey (staceyadams)
      • For quiz engine-related components, add Ravi (ravi-morbia)
      • For a11y-related changes to general components, add Ben (bendansby)
      • For general component-related changes or if you’re not sure about something, add the Design group (NoRedInk/design)

Copy link

linear bot commented Dec 4, 2024

@michaelglass michaelglass force-pushed the KRA-2093-add-writing-icons branch from e71f245 to 8fd5d12 Compare December 4, 2024 10:48
@michaelglass michaelglass marked this pull request as ready for review December 4, 2024 10:53
@michaelglass michaelglass requested a review from bcardiff December 4, 2024 10:54
@michaelglass michaelglass added this pull request to the merge queue Dec 4, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 4, 2024
@michaelglass michaelglass added this pull request to the merge queue Dec 4, 2024
Merged via the queue into master with commit d58e933 Dec 4, 2024
10 checks passed
@michaelglass michaelglass deleted the KRA-2093-add-writing-icons branch December 4, 2024 12:42
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.

2 participants