Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
109 lines (73 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

109 lines (73 loc) · 2.09 KB

Contributing to Agent Observer

Thanks for contributing.

Before You Start

  1. Read the CODE_OF_CONDUCT.md.
  2. Check open issues and PRs to avoid duplicate work.
  3. For security issues, do not open a public issue. Follow SECURITY.md.

Local Setup

Prerequisites:

  • Node.js 22.x
  • pnpm 10.12.4

Runtime and types policy:

Install:

pnpm install

Run desktop app:

pnpm dev

Run web app:

pnpm -C web dev

Development Workflow

  1. Create a branch from main.
  2. Make focused changes.
  3. Run checks locally.
  4. Open a PR with clear context and test evidence.

Suggested branch naming:

  • feat/<short-name>
  • fix/<short-name>
  • docs/<short-name>
  • chore/<short-name>

Required Checks

Run these before opening or updating a PR:

pnpm lint
pnpm lint:web
pnpm typecheck
pnpm build
pnpm -C web build
pnpm test:coverage

If your change touches desktop behavior, also run:

pnpm test:smoke

Ruleset required checks (exact GitHub check names):

  • Desktop Lint, Typecheck, Build
  • Frontend Lint, Typecheck, Build
  • Smoke Coverage (non-Electron)
  • Smoke Scope
  • Desktop Smoke (Electron)

Commit and PR Guidelines

  • Prefer small, reviewable commits.
  • Use clear commit messages (Conventional Commit style is recommended).
  • Include screenshots or recordings for UI changes.
  • Document behavior changes in CHANGELOG.md under Unreleased.

Docs Changes

Docs and guides live in web/content/docs/.

When changing product behavior:

  • Update relevant docs pages.
  • Keep examples and command snippets in sync.

Release Installers

  • Website installer endpoint: /download (serves macOS .dmg when available).
  • GitHub Action: Release Desktop Installer uploads .dmg assets to published releases.
  • Manual backfill for an existing tag:
gh workflow run "Release Desktop Installer" -f tag=v1.2.0

Questions

See SUPPORT.md for where to ask questions and report issues.