Menu
Arc Publishing LogoArc Design SystemDocsBlog
GitHub
Arc Publishing LogoArc Design System
  • Docs
  • Blog
  • GitHub
  • Getting started
    • Installation
    • Configuration
  • Development guides
    • Contributing
    • Quality checklist
    • Technical documentation
    • Theming
    • Component design
    • Zeplin integration
  • Foundations
    • Archiving
    • Color
    • Copy/Content
    • Elevation
    • File upload
    • Form validation
    • Links
    • Notifications
    • Page layout
    • Pagination
    • Revision history
    • Skeleton page
    • Spacing
    • Typography
  • Components
    • Alert
    • Alert dialog ๐Ÿšง
    • Badge ๐Ÿšง
    • Box
    • Button
    • Button group ๐Ÿšง
    • Card ๐Ÿšง
    • Checkbox ๐Ÿšง
    • Chiclet ๐Ÿšง
    • Dialog
    • Select - Single ๐Ÿšง
    • Select - Multi ๐Ÿšง
    • Emoji
    • Flex
    • Frame
    • Heading
    • Icon
    • Icon Button
    • Overflow Menu
    • Page
    • Radio ๐Ÿšง
    • Sidebar
    • Snackbar
    • Stack
    • Text
    • Text Field ๐Ÿšง
    • Toggle ๐Ÿšง
    • Tooltip ๐Ÿšง
    • Work Bar ๐Ÿšง
  • Hooks
    • useNotification

Quality checklist

Ideally, each component should consist of the following.

#Static types

  • Have a TS interface for props documented with JSDoc comments. These will come through on the website. See Snackbar.tsx for an example.

#Testing

  • Have at least one unit test--one of the tests should be an accessibility test via jest-axe
  • Pass Prettier and ESLint

#Review

  • Review component(s) functionality with a designer
  • Review accessibility standards
  • Create/Update technical documentation
Previous
ยซ Contributing
Next
Technical documentation ยป
  • Static types
  • Testing
  • Review
Copyright ยฉ 2021 Arc Publishing