Skip to content

Commit

Permalink
Add links to design checklist (#433)
Browse files Browse the repository at this point in the history
* adds links to contributions design checklist

* Update content/guides/contribute/design.mdx

Co-authored-by: Emily Brick <emilybrick@github.com>

* typo fix

---------

Co-authored-by: Emily Brick <emilybrick@github.com>
  • Loading branch information
mperrotti and emilybrick authored Mar 17, 2023
1 parent a0aea3e commit 4f5b87c
Showing 1 changed file with 11 additions and 14 deletions.
25 changes: 11 additions & 14 deletions content/guides/contribute/design.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,9 @@ When creating a new pattern, we advise starting with an audit of similar pattern

Finally, consider where a pattern will live in the context of a system. A pattern designed for a specific context is not likely to be considered a reusable component.



## Share early, and often

There are many opportunities to get feedback from Primer maintaners.
There are many opportunities to get feedback from Primer maintainers.

**Systems designers** provide extra context and considerations for designing with system-wide considerations
**Accessibility designers** provide context and considerations for accessible and inclusive design
Expand All @@ -41,14 +39,13 @@ There are different ways you can ask for and get feedback:

## Design checklist

All Design patterns for Primer Library consideration should at minimum:

- [ ] **Leverage Primer**: Leverages the foundational building blocks and tools of Primer. Reuses or extends existing patterns and primitives rather than creating overrides
- [ ] Colors, spacing, sizes, and typographic styles from @primer/primitives
- [ ] All icons come from @primer/octicons
- [ ] Responsive
- [ ] **Maintains high design quality:** Visually in harmony with GitHub UI and all visual elements are used are in their correct context
- [ ] **Prioritizes code as a top concern:** Designed with code quality and component API top of mind
- [ ] **Is inclusive:** Designs follow Primer accessibility guidelines and consider a global audience
- [ ] **Has documentation:** Design patterns are [documented](https://primer.style/design/guides/contribute/documentation) for easy adoption

All design patterns for Primer Library consideration should at minimum:

- [ ] **Leverage Primer**: Leverages the foundational building blocks and tools of Primer. Reuses or extends existing patterns and primitives rather than creating overrides
- [ ] Colors, spacing, sizes, and typographic styles from [@primer/primitives](https://github.com/primer/primitives/)
- [ ] All icons come from [@primer/octicons](https://github.com/primer/octicons/)
- [ ] Considers the criteria in the [responsive design guidelines](https://primer.style/design/foundations/responsive)
- [ ] **Maintain high design quality:** Visually in harmony with GitHub UI and all visual elements are used are in their correct context
- [ ] **Prioritize code as a top concern:** Designed with code quality and component API top of mind
- [ ] **Be inclusive:** Designs follow Primer [accessibility guidelines](https://primer.style/design/guides/accessibility/guidelines) and considers a global audience
- [ ] **Have documentation:** Design patterns are [documented](https://primer.style/design/guides/contribute/documentation) for easy adoption

0 comments on commit 4f5b87c

Please sign in to comment.