Contributing
Contributions are welcome — new providers, new AI runners, bug fixes, and docs improvements.
Getting started
- Fork the repository
- Create a feature branch:
git checkout -b feature/my-feature - Make your changes
- Build and test:
npm install && npm run build && npm test - Open a pull request
Development setup
bash
git clone https://github.com/qelos-io/aidev
cd aidev
npm install
npm run dev -- init
npm run dev -- run --helpDocumentation
The full documentation site lives in documentation/. To work on it locally:
bash
cd documentation
npm install
npm run devAdding a provider
- Create
src/providers/<name>.tsimplementing theTaskProviderinterface - Register it in
src/providers/index.ts - Add config keys to
src/types.tsandsrc/config.ts - Document env vars in
.env.aidev.exampleand the docs site
Adding an AI runner
- Create
src/ai/<name>.tsimplementing theAIRunnerinterface - Register in
src/ai/index.ts - Document in the AI agents page
See CONTRIBUTING.md in the repository for the full guide.