Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (67 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

94 lines (67 loc) · 2.91 KB

Contributing to Fozikio

Thanks for your interest in contributing. This guide covers all Fozikio repos — cortex-engine, plugins, reflex, sigil, and more.

Quick start

# Clone the repo you want to work on
git clone https://github.com/Fozikio/<repo>.git
cd <repo>
npm install
npm test

Finding work

If you want to work on something, comment on the issue first so we don't duplicate effort.

Development workflow

  1. Fork the repo and create a branch from main or master
  2. Write code — follow the existing style in the repo
  3. Test — run npm test and make sure everything passes
  4. Commit — write clear commit messages (see below)
  5. Push to your fork and open a Pull Request

Commit messages

Use short, descriptive messages:

feat: add belief decay threshold config
fix: prevent duplicate observations on rapid writes
docs: add plugin authoring guide
refactor: extract embedding logic to shared util

Prefixes: feat, fix, docs, refactor, test, chore, perf

Code style

  • TypeScript for all packages
  • Strict typing — type all function signatures and return values
  • Named exports over default exports
  • async/await over .then() chains
  • No unused imports or variables (CI will catch these)

Plugin development

Cortex plugins follow a standard structure. See the Plugin Authoring Guide on the wiki.

tools-<name>/
├── src/
│   └── index.ts    # Tool definitions
├── package.json    # Must have cortex-engine as peerDependency
├── tsconfig.json
└── README.md

Pull requests

  • Keep PRs focused — one feature or fix per PR
  • Fill out the PR template
  • Link to the issue you're addressing
  • Add tests for new functionality
  • Update docs if you're changing behavior

Reporting bugs

Use the Bug Report issue template. Include:

  • What you expected vs what happened
  • Steps to reproduce
  • Your environment (Node version, OS, cortex-engine version)

Suggesting features

Use the Feature Request issue template. Tell us:

  • What problem you're solving
  • How you'd want it to work
  • Whether you'd be interested in implementing it

Community

  • GitHub Discussions on cortex-engine for questions and ideas
  • GitHub Issues for bugs and feature requests

License

All Fozikio repos are MIT licensed. By contributing, you agree that your contributions will be licensed under MIT.