Skip to content

AGENTS.md

Latest commit

 

History

History
51 lines (37 loc) · 2.69 KB

AGENTS.md

File metadata and controls

51 lines (37 loc) · 2.69 KB

Repository Guidelines

Related Agent Docs

Document Purpose Location
Copilot Instructions Detailed architecture and codebase conventions for agent work .github/copilot-instructions.md

Project Structure & Module Organization

  • src/: TypeScript source. Core entry src/index.ts. Feature areas in src/converters/, src/features/, src/utils/, src/config/.
  • tests/: Jest specs, naming *.spec.ts (example: tests/trafficlights.spec.ts).
  • assets/: Static assets referenced by the extension.
  • example-data/: Sample OSI/MCAP inputs for local testing.
  • dist/: Build output generated by yarn run build or yarn run package.
  • docs/: Project documentation and plans.

Build, Test, and Development Commands

  • yarn install: Install dependencies.
  • yarn build: Build the extension into dist/.
  • yarn local-install: Build and install into local Lichtblick for manual testing.
  • yarn package: Create a .foxe bundle.
  • yarn test: Run Jest test suite.
  • yarn lint: Run ESLint with auto-fix; yarn lint:ci for CI-style linting.

Coding Style & Naming Conventions

  • Language: TypeScript (React where applicable); keep files in *.ts or *.tsx.
  • Formatting: Prettier with 2-space indent, 100-char line width, semicolons, LF line endings.
  • Linting: ESLint with @lichtblick configs; follow lint fixes before committing.
  • Imports: Prefer path aliases from tsconfig.json (@/, @utils/, @features/, @converters, @assets).

Testing Guidelines

  • Framework: Jest + ts-jest, jsdom environment.
  • Test location/pattern: tests/**/*.spec.ts.
  • Expectation: Add or update tests alongside changes to converters, metadata handling, or feature behavior.

Commit & Pull Request Guidelines

  • Commits follow Conventional Commits: <type>(<scope>): <description> with 72-char max header.
  • Common types in history: feat, fix, docs, style, refactor, test, chore, ci.
  • Always sign commits: use git commit -s -S (DCO sign-off + GPG signature) for every commit.
  • Never mention "Copilot" in commit messages, PR descriptions, code comments, or any other repository content. Do not add Co-authored-by: Copilot trailers.
  • PRs should include a short summary, testing notes (e.g., yarn test, yarn lint), and link related issues. CODEOWNERS are listed in CODEOWNERS; follow the repo’s required review rules.

Lint & Autofix Safety

  • When running yarn lint (autofix), only stage files that belong to your current change. Never commit autofixes to unrelated files.
  • Prettier changes are formatting-only and safe. ESLint autofixes (e.g., prefer-optional-chain) can alter logic — review every diff line before committing.