GitHub

Developer Guides

ClimaCore.jl follows the shared CliMA Developer Guides — engineering standards, architectural patterns, and development guidelines for human and AI developers across the CliMA ecosystem.

Where to find them

The guides are vendored as a Git subtree in this repository at docs/dev-guides/. The canonical source is CliMA/DeveloperGuides on GitHub. A scheduled workflow syncs the local copy monthly.

What they cover

  • Architecture — repo structure conventions, ecosystem-wide design patterns, cross-repo contracts, dependency management
  • Performance — GPU kernel rules, broadcast patterns, allocation avoidance, type stability
  • Workflow — agent autonomy boundaries, code style, testing, and PR review guidelines

Repo-specific guide

For conventions and patterns specific to ClimaCore.jl (directory layout, key abstractions, test groups), see the repo-specific guide.

Editing the guides

Edits to the shared guidelines belong in the canonical CliMA/DeveloperGuides repository, not in the vendored docs/dev-guides/ copy. Changes made to the subtree copy will be overwritten on the next sync.