Skip to content

Create a template for the Design Lead to create new component issues #717

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

Closed
12 tasks done
ExperimentsInHonesty opened this issue Jan 31, 2025 · 6 comments
Closed
12 tasks done

Comments

@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Jan 31, 2025

Overview

We need to create a design issue template so that the design lead can create new components

Action Items

  • copy current draft being used into a comment
  • create a new draft for the template in a comment below
  • finalize the draft
  • create a new template in the Setting for this repo
  • add the
    • Title
    • Description
    • Body (Overview, Action Items, Resources)
    • Add the Title that the issues created using the template will have
    • Add the labels
    • Add the milestones
    • Commit the changes that will save the template

Resources/Instructions

@ExperimentsInHonesty
Copy link
Member Author

ExperimentsInHonesty commented Jan 31, 2025

Draft of current template

Details

Overview

We need to create Pagination for the TWE design system for the future website development & handoff.

Details

This issue had been worked on before we decided to update with M3 and other requirements. You can see the prior work on resource 1.04.01 in the section called NEED TEMPLATE REVISION.

Action Items

  • Research styling for Google's M3
  • Create Building Blocks (if applicable)
  • Research Googles M3 guidelines to see what style, state and/or configuration variants are needed
  • Create Style variations
  • Create State Variants (see resource 1.01 and M3 guidelines 1.03)
  • Create Configuration Variants (see resource 1.02 and M3 guidelines 1.03)
  • Weekly (or more often if needed) communicate changes in issues comments (below) and with design team
  • Get sign-off from Design Lead
  • Get sign-off from Product Manager (general and Dev)
  • Update Figma page: Design System - WIP (resource 1.04)
    • Add all the details that canvas asks for (see resources 1.04.01 for example of what/where you are updating)
  • Update Figma page: Microsite Ready for Dev
  • Close Issue
  • Update epic by checking box TWE Design System: Create Generic Design Components and Mockups #397
  • leave a comment on Develop Design System Microsite based on Material for MKDocs #455 with the following text
    Issue #[REPLACE WITH YOUR ISSUE NUMBER] has been released by design
    

Resources/Instructions

@ExperimentsInHonesty
Copy link
Member Author

ExperimentsInHonesty commented Jan 31, 2025

Template

Setting up this issue
Customize the following

  • add the milestone 05.01.01 TWE Design System - Design

  • 1.01 define which states you want used

  • 1.02 define which configurations you want used

  • 1.03 Go to link provided, find appropriate menu item and replace link

  • 1.04.02 (GO TO FIGMA, NEED TEMPLATE/REVISION AND SEE IF THERE IS AN EXISTING COMPONENT TO REMOVE.
    IF YES, UPDATE 1.04.02 IN THE RESOURCES.
    IF NO, DELETE 1.04.02 FROM THE RESOURCES AND THE CHECKBOX IN THE ACTION ITEMS.

  • Add labels

Overview

We need to create Pagination for the TWE design system for the future website development & handoff.

Details

This issue had been worked on before we decided to update with M3 and other requirements. You can see the prior work on resource 1.04.01 in the section called NEED TEMPLATE REVISION.

Action Items

  • Research styling for Google's M3
  • Create Building Blocks (if applicable)
  • Research Googles M3 guidelines to see what style, state and/or configuration variants are needed
  • Create Style variations
  • Create State Variants (see resource 1.01 and M3 guidelines 1.03)
  • Create Configuration Variants (see resource 1.02 and M3 guidelines 1.03)
  • Weekly (or more often if needed) communicate changes in issues comments (below) and with design team
  • Get sign-off from Design Lead
  • Get sign-off from Product Manager (general and dev)
  • Update Figma page: Design System - WIP (resource 1.04)
    • Add all the details that canvas asks for (see resources 1.04.01 for example of what/where you are updating)
    • If there is a link with a strike-through on 1.04.02, please go to the link, and remove that content from the NEED TEMPLATE/REVISION section.
  • Update Figma page: Microsite Ready for Dev
  • Close Issue
  • Update epic by checking box TWE Design System: Create Generic Design Components and Mockups #397
  • leave a comment on Develop Design System Microsite based on Material for MKDocs #455 with the following text
    Issue #[REPLACE WITH YOUR ISSUE NUMBER] has been released by design
    

Resources/Instructions

@ExperimentsInHonesty
Copy link
Member Author

ExperimentsInHonesty commented Mar 20, 2025

@ExperimentsInHonesty will turn into a template
@mklmrgn will use the template above to update the design issues in the New issue approval column

@Rabia2219

This comment has been minimized.

@Rabia2219
Copy link
Member

Notes

Template has been created

@Rabia2219
Copy link
Member

@mklmrgn
The template has been created and is available as a template under New issue or via the link above.

@github-project-automation github-project-automation bot moved this from In progress (actively working) to Done in P: TWE: Project Board Apr 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment