Skip to content

quality-grades.md

Latest commit

 

History

History
33 lines (23 loc) · 1.52 KB

quality-grades.md

File metadata and controls

33 lines (23 loc) · 1.52 KB

Package Quality Grades

This file tracks the documentation and test coverage quality of v9 component packages. Updated during periodic documentation audits.

Grading Criteria

Grade Meaning
A README + stories + tests + API docs all present and current
B Missing one of: complete README, full story coverage, or up-to-date API docs
C Missing two or more quality signals
D Minimal or no documentation/testing

Quality Signals

  • README: Has description, install command, usage example
  • Stories: Has stories/ directory with Default story and variant coverage
  • Tests: Has unit tests with reasonable coverage
  • API docs: .api.md file exists and matches current exports
  • Conformance: testing/isConformant.ts exists and passes

Current Grades

Package README Stories Tests API Docs Conformance Grade
To be populated by first docs audit run

How to Update

This table is populated during periodic documentation audits.