Code Quality Requirements
September 22, 2025 ยท View on GitHub
This directory contains code quality detection tool documentation for different programming languages, integrated with the Makefile toolchain.
Supported Languages
| Language | Documentation | Makefile Commands | Toolchain |
|---|---|---|---|
| Go | go.md | make fmt-go, make check-go | gofmt + goimports + gofumpt + golines + staticcheck + golangci-lint |
| Java | java.md | make fmt-java, make check-java | spotless + checkstyle + spotbugs + pmd |
| Python | python.md | make fmt-python, make check-python | black + isort + flake8 + mypy + pylint |
| TypeScript | typescript.md | make fmt-typescript, make check-typescript | prettier + eslint + tsc |
Quick Start
Unified Commands (Recommended)
make format # Format all languages
make check # Check all language quality
Single Language Commands
make fmt-go && make check-go # Go
make fmt-java && make check-java # Java
make fmt-python && make check-python # Python
make fmt-typescript && make check-typescript # TypeScript
Documentation Overview
Each language documentation includes:
- Toolchain description
- Quality standards
- Makefile integration
- Common issue resolution
Related Documentation
- Branch and Commit Standards - Branch management and commit message standards
- Makefile Usage Guide - Complete Makefile command reference
- Local Development Configuration - Using
.localci.tomlfor modular development