Contributing

kunji is open source and contributions are welcome.

Report a bug or suggest an idea

Open an issue. For bugs, include the output of kunji doctor and kunji version, and never paste API keys.

Security problems: report them privately through GitHub security advisories.

Improve the docs

Every page has an Edit page link at the bottom that opens the file on GitHub. Pages are Markdown files in docs-site/src/content/docs/.

The command reference, provider pages, chat commands, environment variables and changelog are generated from kunji’s code by scripts/gen_docs.py, so change the code (or the script), not those pages.

Run the docs locally:

python -m pip install -e .
python scripts/gen_docs.py
cd docs-site
npm ci
npm run dev

Contribute code

git clone https://github.com/testwithsuraj/kunji
cd kunji
python -m pip install -e ".[dev]"
ruff check src tests
pytest

Read CONTRIBUTING.md for the full guidelines.