Code Quality And Validation

Code Quality & Validation Standards

This skill defines the multi-tier code quality, formatting, linting, and type checking standards across the GitHub Backup Automation System monorepo.

1. Branch-First Development

[!IMPORTANT] CREATE A LOCAL BRANCH FIRST: Always start by creating a local branch from main:

git switch -c MishraShardendu22/main/<feature-name>

Never develop code or run refactors directly on main.

2. Tooling Matrix by Language

2. Code Quality Rules

1. Go Guidelines

• Always format code using standard gofmt before committing.
• Zero compiler warnings or go vet issues allowed.
• Prefer structured logging via util.Logger() in CLI and logger.Log (slog) in backend/.
• Clean up goroutines and database connection handles using defer.

2. Python Observatory Guidelines

• Python 3.12+ type annotations required on all function arguments, return types, and Pydantic models.
• Zero errors in Pyright type checking (agentic-observatory/pyrightconfig.json).
• Ensure all async functions and SQLAlchemy sessions are properly awaited and closed.

3. Frontend TypeScript Guidelines

• Strict TypeScript checks with zero any types wherever possible.
• Use Biome for combined linting and code formatting (frontend/package.json).
• Ensure components render cleanly in Next.js Turbopack production builds.

3. Developer CLI Runbook

# Auto-format all Go and TypeScript files
make format

# Run all linters across Go, Python, and Frontend
make lint

# Run static type checkers across Python and Frontend
make typecheck

# Full pre-commit validation pass
make pre-commit