Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (26 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 1.01 KB

Contributing

Setup

npm install
npm run build
npm test

Development Workflow

  1. Create a branch from main.
  2. Make focused changes with tests.
  3. Run npm run build and npm test before opening a PR.
  4. Run npm run verify-release to check version and config consistency.
  5. If your change affects Cortex API behavior, also run npm run test:integration with CORTEX_API_KEY set.

Project Layout

  • src/ plugin source code
  • tests/unit/ unit tests
  • tests/integration/ live API integration tests
  • tests/manual/ manual harness/proof scripts
  • docs/ internal architecture, planning, testing, and agent docs

Pull Requests

  • Keep PRs scoped to one concern.
  • Update docs when behavior or configuration changes.
  • Add or adjust tests for bug fixes and features.

Issues & Discussions