Skip to content

project-context.md

Latest commit

 

History

History
40 lines (30 loc) · 1.64 KB

project-context.md

File metadata and controls

40 lines (30 loc) · 1.64 KB
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 that automates Git-Flow: creates branches from issue labels, links issues/PRs to projects, tracks commits; AI via OpenCode (progress, errors, PR descriptions).
  • 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 20, run from repo root; edit only src/; use INPUT_KEYS/ACTIONS and logInfo/logError/logDebugInfo. When adding inputs: update action.yml, constants.ts (INPUT_KEYS), and github_action.ts (and optionally local_action.ts).
  • Don’t: Edit or depend on build/ (generated by ncc); run tests/lint on build/.

Commands (repo root)

nvm use 20
npm install
npm run build
npm test
npm run test:watch
npm run test:coverage
npm run lint
npm run lint:fix
  • Build: npm run build → bundles github_action.ts and cli.ts into build/.
  • Tests: Jest; npm run test:watch / npm run test:coverage as needed.
  • Lint: ESLint + typescript-eslint on src/; npm 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 (entry points, use cases, single actions, key files).
  • Code conventions: see code-conventions.md (logger, constants, adding inputs, ncc).