Skip to content

Commit

Permalink
chore: add pattern exploration jira template (#4079)
Browse files Browse the repository at this point in the history
* chore: add pattern exploration jira template

* fix: link to SOP in contribution guidelines

* chore: remove broken image

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
  • Loading branch information
serifluous and kodiakhq[bot] authored Sep 19, 2024
1 parent d108aeb commit 994bdd5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.`
Expand Down Expand Up @@ -42,4 +40,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.
13 changes: 10 additions & 3 deletions internal-docs/process/epic-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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._
Expand Down

0 comments on commit 994bdd5

Please sign in to comment.