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

LanguageDocumentationMakefile CommandsToolchain
Gogo.mdmake fmt-go, make check-gogofmt + goimports + gofumpt + golines + staticcheck + golangci-lint
Javajava.mdmake fmt-java, make check-javaspotless + checkstyle + spotbugs + pmd
Pythonpython.mdmake fmt-python, make check-pythonblack + isort + flake8 + mypy + pylint
TypeScripttypescript.mdmake fmt-typescript, make check-typescriptprettier + eslint + tsc

Quick Start

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