Skip to content

contributing.md

Latest commit

 

History

History
51 lines (38 loc) · 1.31 KB

contributing.md

File metadata and controls

51 lines (38 loc) · 1.31 KB

Contributing

Development setup

Prerequisites: Bun 1.3+, Cortex Code CLI

git clone https://github.com/anthu/cortex-code-action
cd cortex-code-action
bun install

Project structure

src/
├── entrypoints/run-cortex.ts  # Main entry point
├── security/                  # canUseTool gate and blocklists
├── modes/                     # Mode detection and prompt assembly
├── prompt/                    # System prompts
├── github/                    # Comment and commit utilities
└── utils/                     # Output sanitization
test/
└── security/                  # Unit tests for security gate
docs/                          # Detailed documentation
examples/                      # Ready-to-use workflow files

Running tests

bun test

Type checking

bun run typecheck

Adding a security test

Add test cases to test/security/can-use-tool.test.ts. Every new blocked tool or path pattern should have a corresponding test.

Releasing

  1. Update CHANGELOG.md
  2. Commit: git commit -m "chore: release v0.x.0"
  3. Tag: git tag v0.x.0
  4. Push: git push && git push --tags
  5. Create release: gh release create v0.x.0 --generate-notes