Skip to main content

Engineering Standards

Quality Baseline​

  • Keep page files thin; move logic to components/utilities.
  • Prefer simple, explicit implementations.
  • No partial production code: no placeholders, no TODO stubs.

Testing Standards​

  • Prefer integration tests over isolated internals mocking.
  • Mock external services at network boundaries only.
  • Add tests for changed behavior, not only existing suite runs.

Documentation Standards​

When behavior changes, update relevant docs and metadata.

Required Docs Metadata​

Each docs page must include:

  • owner
  • last_reviewed
  • status

Governance Checks​

CI enforces:

  • frontmatter validity
  • stale docs detection
  • broken docs links via Docusaurus build
  • docs coverage for code changes

Lint and Test Expectations​

Use package-local scripts first, then monorepo-level checks for broad changes.