Phase 3: Document Formatting Expectations and Linting Tooling

[ckenst]

Overview

Document a supported Prettier command and intentionally add any further linting or pre-commit tooling only when it fits the repository. This ensures consistent code and content formatting across contributions.

Goals

• Document the supported Prettier configuration and command
• Define formatting expectations for Markdown, YAML, HTML, CSS, and JavaScript
• Evaluate and document any additional linting tools (e.g., YAML linters, Markdown linters) if they add value without overhead
• Create a contributor-friendly guide to formatting

Implementation Notes

• Review existing .prettierrc and .prettierignore configuration
• Document supported commands for local formatting
• Add pre-commit hooks or CI checks only if they fit the repository's philosophy
• Ensure tooling doesn't conflict with the existing validator or build process
• Keep guidance concise and actionable
• Test all documented commands locally

Related

• Part of Phase 3: Developer Experience (DX) & AI Workflows
• Complements: Prompt Imports issue
• Supports: Local Verification Docs issue

Acceptance Criteria

• Prettier command is documented and tested locally
• Formatting expectations are clear for each file type
• Any additional linting tools are evaluated against repository fit
• Documentation is added to CONTRIBUTING.md or a dedicated formatting guide
• Contributors can easily format files using documented commands

Resources

• ROADMAP.md Phase 3
• Prettier documentation: https://prettier.io/docs/
• Repository .prettierrc configuration