mirror of
https://github.com/bitwarden/clients.git
synced 2026-11-16 07:03:29 +00:00
* [CL-1016] Add review guidelines to components CLAUDE.md * [CL-1016] Move CL guidelines to CODE_STYLE.md and address review * [CL-1016] Move scope and process rules to CONTRIBUTING.md * [CL-1016] Remove external links from CODE_STYLE.md * [CL-1016] Simplify design sign-off requirement * [CL-1016] Allow CODE_STYLE.md in capital filename lint * [CL-1016] Address review feedback on a11y, testing, and promotion guidance
1.2 KiB
1.2 KiB
Contributing to @bitwarden/components
What Belongs Here
- This library holds low-level, domain-agnostic UI. Domain-coupled UI (ciphers, billing, onboarding tours) belongs in the owning team's folder; business logic belongs in services.
- Promote UI into this library once a second team needs it. Promotion usually requires rework first: decouple business logic and generalize inputs and slots.
Requirements
- Contributions to this library MUST be made in a standalone PR, independent of changes to downstream apps or libraries. The only exception is when migrating existing consumers due to a breaking API or design change, which must be pre-approved by
@bitwarden/team-ui-foundation. - Breaking changes and non-obvious changes to consumer code MUST be called out explicitly in the PR description.
- Visual or behavioral changes MUST have Design sign-off and be documented in Figma.
- Every component MUST have Storybook coverage for each visual state and variant it supports. Stories are this library's primary documentation and visual regression surface, so prefer them over Jest rendering specs, which duplicate that coverage. Reserve Jest for non-rendering logic.
- Follow the code style.