Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (30 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1.83 KB

Contributing

First open-source project. Learning as I go. That said, I genuinely want collaborators — this started as a personal system and needs other perspectives.

What Would Help Most Right Now

  1. Port analyze.py to Node.js — The learning loop is ~970 lines of Python. Everything else is Node/shell. One runtime = lower adoption barrier.
  2. Tests — Zero tests. The promotion logic (auto-writing to .claude/rules/) especially needs coverage.
  3. Linux/WSL testing — Built on macOS M1, never tested anywhere else.
  4. Domain packs — Professional expertise + Claude Code experience = installable knowledge. See domain-packs/example-pack/ for the format.
  5. Architecture feedback — Is the config schema sane? Is the hook pipeline right? Would you actually install this? Why not?

How to Contribute

git clone https://github.com/somarakis/cortex.git
cd cortex
npm install
  • Bug reports: Open an issue. Include OS, Node version, Claude Code version.
  • Ideas: Open an issue tagged "idea" or "discussion".
  • Code: Fork, branch, PR. One thing per PR.
  • Domain packs: Copy domain-packs/example-pack/, fill in your expertise.

Understanding the System

Read these in order:

  1. README.md — What it is and why
  2. EVOLUTION.md — How it got here (all the wrong turns included)
  3. docs/hooks/ — Hook lifecycle and authoring guide
  4. ROADMAP.md — Where it's going

Code Style

No linter yet. Follow conventions you see in existing code. If something's inconsistent, fix it.

Be Direct

I'm a lawyer who learned to code by building this with Claude Code. My code probably looks like it. Constructive feedback > polite silence. Tell me what doesn't make sense.

License

By contributing, you agree your work is licensed under MIT.