Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (34 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

44 lines (34 loc) · 1.89 KB

Contributing to Keiko

Keiko is built to a production-ready, enterprise quality bar: strict TypeScript (no any), tested behavior, minimal runtime dependencies, and reviewable, evidence-backed changes. The architecture and release constraints are recorded in the Architecture Decision Records; read the current decisions before opening a pull request.

Local development

npm install        # install dev tooling and generate package-lock.json
npm run build      # compile TypeScript outputs
npm test           # run the unit test suite
npm run lint       # ESLint, zero-warning policy
npm run typecheck  # strict type-checking for src + tests

Pull requests

All eight required CI status checks must pass before a change can merge into dev:

  1. ci
  2. actionlint
  3. Verify pinned action SHAs
  4. Analyze (actions)
  5. Analyze (javascript-typescript)
  6. Build, scan, SBOM, smoke
  7. Review dependency diff (dev/main)
  8. ui

The rationale for the package architecture, workspace gate, bundled publish model, and 0.2.0 baseline is recorded in ADR-0019, ADR-0020, ADR-0021, and ADR-0025.

Published release notes live in GitHub Releases. This repository intentionally does not maintain a root CHANGELOG.md.

Troubleshooting documentation

Operator-facing failure modes live in docs/troubleshooting/README.md. When adding a new entry, copy docs/troubleshooting/_template.md and follow the Symptom, Root Cause, Diagnostic Steps, and Resolution structure. Do not include API keys, customer data, internal endpoints, or unredacted log lines in examples.