Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

External Standards

GoudEngine builds on established external standards instead of inventing local conventions. Each standard below is paired with the gate or tool that enforces or cites it, so a claim of compliance maps to something that runs.

StandardGovernsEnforcer / citation
SemVerVersion numbers and compatibility promisesrelease-please (release-please-config.json)
Conventional CommitsCommit message and PR title formatcommit-msg hook (.husky/hooks/commit-msg) + PR-title check (.github/workflows/pr-validation.yml)
Keep a ChangelogChangelog structure and groupingrelease-please (generates CHANGELOG.md)
RFC 2119MUST/SHOULD/MAY keywords in normative docsInstruction and rule docs (.agents/rules/, CLAUDE.md)
Rust API GuidelinesIdiomatic public Rust API surfacecargo clippy -- -D warnings
C-ABI / FFI safetyThe extern "C" boundary and generated C headersFFI rules (.agents/rules/ffi-patterns.md) + scripts/validate_c_header.py

Rules

  • Link the canonical source; never restate it. A row cites the upstream standard and names the gate. It does not paraphrase the standard’s contents, which drift out of date the moment the standard changes.
  • Adopt enforcer-first. Adding a standard means adding a row only once a gate or tool enforces or cites it. A standard with no enforcer is a wish, not a practice; wire the check first, then record the row.