From bbe4941947baf5b1a479f3f74b7d9622c13d5c7c Mon Sep 17 00:00:00 2001 From: Sarah Date: Tue, 17 Sep 2024 15:33:34 -0700 Subject: [PATCH 1/3] chore: add pattern exploration jira template --- internal-docs/process/epic-template.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/internal-docs/process/epic-template.md b/internal-docs/process/epic-template.md index cd337f8c17..2b9ff1d081 100644 --- a/internal-docs/process/epic-template.md +++ b/internal-docs/process/epic-template.md @@ -72,12 +72,19 @@ _Create this as a placeholder. Add details as they come to light, or close the t _If the component API is somewhat unknown, this ticket can be done before building the component package. If the API is known, this can be closed as “won’t do”._ -- Research what other design system libraries are currently doing for their version -- Build prototypes in CodeSandbox to explore possible API directions -- Review prototypes with DSYS +- Research what other design system libraries are currently doing for their version. +- Build prototypes in CodeSandbox to explore possible API directions. +- Review prototypes with DSYS. - Post the API exploration and spec (coordinate with whoever's writing the spec) on Github as an RFC. - Decide what the component API should be. Add a link in the corresponding component package ticket, or create the ticket. +### Create initial pattern layout + +_If the design is straightforward and/or has limited interactions, this can be closed as “won’t do”._ + +- Build prototypes in Storybook to make sure components in the pattern work together so we can check accessibility early. Base these prototypes on the most varied iterations Design currently has (choose < 3) to help check for feasability and uncover any usability issues. +- Review prototypes with DSYS. + ### Create component package _If the full component can’t be completed in one sprint, split this ticket up for the different variations of this component._ From 1626dc07b08c920d2cfdb47545ededf4cd6ef9fe Mon Sep 17 00:00:00 2001 From: Sarah Date: Tue, 17 Sep 2024 15:58:35 -0700 Subject: [PATCH 2/3] fix: link to SOP in contribution guidelines --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 695d8098f2..769b2c0f9f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,4 +42,4 @@ ## Standard Operating Procedures -All contributions must abide by our [Standard Operating Procedures](https://github.com/twilio-labs/paste/blob/main/STANDARD_OPERATING_PROCEDURES.md). This helps us mitigate errors caused by oversight or forgetfulness by leaning on lessons learned through past mistakes. +All contributions must abide by our [Standard Operating Procedures](https://github.com/twilio-labs/paste/blob/main/internal-docs/engineering/standard-operating-procedures.md). This helps us mitigate errors caused by oversight or forgetfulness by leaning on lessons learned through past mistakes. From a217d295b13635e81727150b9ec00f01d545ff90 Mon Sep 17 00:00:00 2001 From: Sarah Date: Tue, 17 Sep 2024 16:17:26 -0700 Subject: [PATCH 3/3] chore: remove broken image --- CONTRIBUTING.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 769b2c0f9f..5726d25567 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,8 +8,6 @@ ## Package Requirements -![Image of good structure](https://cdn.discordapp.com/attachments/293855810063302657/599371250925699072/unknown.png) - - [ ] a `package.json` file with the following sub-requirements: - The following scripts: `build, build:dev, clean, type-check, prepublishOnly`. - Author must be `Twilio Inc.`