readme-standards

You can standardize README conventions by applying a shared template that enforces badge usage, license references, and section structure across all internal and public monorepo packages. This ensures consistency and readability for every package README.

A package README template should include a Quick Start one-liner, license badges, and structured sections aligned with SKILL.md frontmatter requirements. These standard sections improve readability and maintain consistent documentation across packages.

Badges and license references in documentation provide quick visual indicators of package status and legal terms. Standard rules define exactly which badges to display and how to reference licenses to maintain consistency across all package READMEs.

Yes, this README standard applies to both private and public packages within the monorepo. It helps maintain appropriate content distinctions, ensuring private versus public packages display the correct documentation elements.

You need to update an existing README.md file whenever creating or modifying package documentation in the monorepo. Applying the standard conventions during any update ensures ongoing compliance with template structure, badge rules, and section requirements.

The best way to ensure README compliance is to align your README content directly with the SKILL.md frontmatter and detailed section requirements. This includes implementing the Quick Start one-liner and proper license badges to meet the standardized conventions.