Skip to main content
Version: Latest

Code Style and Quality

Formatting and static checks are enforced by repository configuration. Use the checked-in tools instead of maintaining separate editor-specific rules.

Run the shared checks​

Install the repository-managed hooks and run them across tracked files:

make precommit-install
make precommit-check

To reproduce the containerized pre-commit workflow:

make precommit-local

The changed-file validation report may require additional language or domain checks:

make agent-report ENV=cpu CHANGED_FILES="path/one,path/two"

Language conventions​

Go​

  • Format with gofmt.
  • Keep packages and files focused on one responsibility.
  • Document exported APIs where their purpose is not self-evident.
  • Verify module metadata with make check-go-mod-tidy.
  • Use make go-lint for the repository lint configuration.

Rust​

  • Format with cargo fmt.
  • Run cargo clippy through the repository's reported validation path.
  • Return typed errors rather than panicking in normal failure paths.
  • Keep unsafe and FFI boundaries small and documented.

Python​

  • Support the Python version declared by the package you are changing.
  • Use type hints on public and non-trivial interfaces.
  • Keep command orchestration separate from reusable logic.
  • Run the component's tests through its Make target when one exists.

TypeScript and React​

  • Follow the Dashboard ESLint and TypeScript configuration.
  • Keep data fetching and transformation out of presentational components when a helper or hook owns that responsibility.
  • Add focused component or E2E coverage for user-visible behavior.

Generated files​

Do not hand-edit generated API references, schemas, or catalog blocks. Change their source and run the owning generator, then include both source and output in the same pull request.