Skip to content

Repository navigation

project-context.md

Latest commit

 

History

History
40 lines (30 loc) · 1.85 KB

project-context.md

File metadata and controls

40 lines (30 loc) · 1.85 KB
Raw
name Project Context
description Copilot – quick read, commands, and where to find more

Copilot – Project Context

Quick read (for fast understanding)

  • What it is: GitHub Action + CLI for issue/PR automation, branch management, Bugbot, and configurable release/hotfix orchestration. Agent roles can use Codex, OpenCode, or Cursor according to validated repository configuration.
  • Entry points: GitHub Action → src/actions/github_action.ts; CLI → src/cli.ts. Shared logic in src/actions/common_action.ts (single actions vs issue/PR/push).
  • Do: Use Node 24 and pnpm, run from repo root, and preserve the dependency direction documented in docs/dependency-rules.md. Use INPUT_KEYS/ACTIONS and the existing logger. When adding inputs, update action.yml, src/application/contracts/input_keys.ts, the relevant runtime input adapter, tests, and user documentation.
  • Don’t: Edit build/ directly (it is generated by ncc) or introduce alternate spellings and compatibility paths for canonical contracts.

Commands (repo root)

nvm use 24
pnpm install
pnpm run build
pnpm test
pnpm run test:watch
pnpm run test:coverage
pnpm run lint
pnpm run lint:fix
  • Build: pnpm run build → bundles the GitHub Action, CLI, and typed API into build/.
  • Tests: Jest; pnpm run test:watch / pnpm run test:coverage as needed.
  • Lint: ESLint + typescript-eslint on src/; pnpm run lint:fix to auto-fix.

What to ignore

  • build/ – Generated output; do not edit or run tests/lint against it.
  • .agent-sessions/ – Session data; ignore unless debugging.

Other rules

  • Architecture & paths: see architecture.md, then the authoritative docs/development/architecture.mdx and docs/dependency-rules.md.
  • Code conventions: see code-conventions.md (logger, constants, adding inputs, ncc).