diff --git a/docs/CODE_QUALITY_AND_LINTING.md b/docs/CODE_QUALITY_AND_LINTING.md new file mode 100644 index 0000000..845d4e1 --- /dev/null +++ b/docs/CODE_QUALITY_AND_LINTING.md @@ -0,0 +1,20 @@ +# Code Quality, Formatting, and Linting Runbook + +## Objective +Establishes standardized code formatting, static analysis rules, and CI validation checks for **yieldladder**. + +Related Issue: #43 - [GF-10] [BACKEND] CI/CD Hardening (cargo test, clippy, pnpm lint, SDK build) + +## Standard Quality Gates +1. **Formatting**: Automatic adherence to repository Prettier / rustfmt / Black configurations. +2. **Static Linting**: Zero unhandled compiler warnings and zero strict lint suppressions. +3. **Type Safety**: Full type annotations without implicit `any` escape hatches. + +## Runbook +```bash +# Verify formatting +npm run format:check || cargo fmt --check + +# Execute static analysis +npm run lint || cargo clippy -- -D warnings +```