Skip to content
Sentinel Sentinel docs

Contributing

Contributions are welcome. The short version:

  1. Fork and clone, then pnpm install (see Building from source).

  2. Make your change. Match the style of the surrounding code.

  3. Run the checks before opening a PR:

    Terminal window
    pnpm typecheck
    pnpm lint
    pnpm test        # full suite with coverage — the canonical signal

  4. Write commits as release-note bullets in the enforced conventional-commit format (CI’s commit-lint job checks this). See Releases.

  5. Open a PR against main.

What CI checks

Section titled “What CI checks”
  • Type-check, lint, and the full test suite with coverage (lines/functions/statements ≥ 95%, branches ≥ 93%).
  • The mock budget (pnpm mock:budget) — new mocks need justification. Prefer the fake-Anthropic harness and env seams; see Testing.
  • Commit-message shape.

Editing these docs

Section titled “Editing these docs”

This documentation lives in packages/site/src/content/docs/docs/ as Markdown/MDX. Run the site locally with pnpm --filter @sentinel/site dev and visit /sentinel/docs/. Each page has an Edit page link in the footer that points at its source on GitHub.

Screenshots live in packages/site/public/screenshots/ and are referenced from the MDX pages by hard-coded filename — replace a placeholder with a real capture under the same name and the docs pick it up automatically. Capture the tray window at 2× (Retina) in the dark theme, and redact any real email addresses or org names you don’t want public.