Skip to content

docs(quality): add code quality and linting verification guide for #43 #155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ranjeet2063 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(quality): add code quality and linting verification guide for #43 #155

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/CODE_QUALITY_AND_LINTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```