README.md

Contributor Documentation

In this doc

• About Spectrum Web Components
• About the 1st-gen-to-2nd-gen transition
• About these docs

Beneath this doc

• Contributor guides
  • Getting involved
  • Using the issue tracker
  • Working in the SWC repo
  • Making a pull request
  • Participating in PR reviews
  • Releasing SWC
  • Authoring contributor docs
  • Patching dependencies
  • Accessibility testing
  • Maintaining StackBlitz examples for Spectrum Web Components
  • 2nd gen testing
  • Tools vs packages: where code lives
• Style guide
  • 2nd-Gen CSS
  • 2nd-gen TypeScript
  • Linting tools
  • Testing guide
• Project planning
  • Objectives and strategy
  • Workstreams
  • Components
  • Milestones

About Spectrum Web Components

Spectrum Web Components (SWC) is a library of web components that implements Adobe's Spectrum design system.

While SWC is used primarily by Adobe product teams, it is open-sourced and available for general use.

SWC is developed by a core team in Adobe Design Engineering, but we welcome contributions from inside and outside Adobe.

About the 1st-gen-to-2nd-gen transition

Spectrum Web Components is currently in transition from its first generation (1st-gen) to its second generation (2nd-gen).

• To understand how this transition affects the SWC code base, see Repository Structure.
• To understand the motivation for this transition, see Objectives and Strategy.

About these docs

These docs contain essential information about the SWC project for both maintainers (members of the core team) and contributors from outside the core team.

The docs are organized into sections to help you find the information you need:

Contributor Guides - Topical guides for working on the project. This section includes guides for getting started, understanding processes, and accomplishing specific tasks like adding new components or editing these contributor docs themselves. When you change doc structure or headings, see Authoring contributor docs to regenerate navigation and verify links.

Style Guide - Comprehensive style guide covering project-wide conventions and area-specific rules. This section is useful for human reference and for AI-assisted work, documenting our approaches to linting, JSDoc conventions, component structure, and other coding standards.

Accessibility testing - Automated accessibility testing, snapshots, and manual testing expectations for pull requests.

Project Planning - Strategic planning documentation including objectives, workstreams, component roadmaps, and milestones. This section contains:

• Objectives and Strategy - Strategic context for the 1st-gen-to-2nd-gen transition, including our goals and approach.

• Workstreams - Workstream-centric view of cross-cutting work affecting many or all components, helping us work toward specific objectives and coordinate efforts.

• Components - Component-centric view of individual components and how they're affected by multiple workstreams, useful for understanding each component's roadmap and status.

• Milestones - Information about project milestones and their goals.

Together, the Workstreams and Components views help us manage the project roadmap, ensuring we make progress on strategic objectives while maintaining clarity about the state and evolution of individual components.