Quality checklist

This guide walks through an ideal quality assurance phase for all components.

Ideally, each component should consist of the following.

#RFC

All new components should first go through an RFC process. This is to ensure we meet the needs of all teams at Arc and an API that is flexible. More info on RFCs can be found in the repository.

#Static types

Have a TS interface for props documented with JSDoc comments. Most if not all types for ADS components live in the @wpmedia/ads-types package. This package is not intended for public consumption and may change without warning.

#Testing

  • Have at least one Cypress component test
  • Pass Prettier and ESLint

#Review

  • Review component(s) functionality with a designer
  • Review accessibility standards
  • Create/Update technical documentation
Copyright 2021 Arc XP