Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
27 lines (18 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

27 lines (18 loc) · 1.74 KB

Contributing to Kimi Code CLI

Thank you for being interested in contributing to Kimi Code CLI!

We welcome all kinds of contributions, including bug fixes, features, document improvements, typo fixes, etc. To maintain a high-quality codebase and user experience, we provide the following guidelines for contributions:

  1. We only merge pull requests that aligns with our roadmap. For any pull request that introduces changes larger than 100 lines of code, we highly recommend discussing with us by raising an issue or in an existing issue before you start working on it. Otherwise your pull request may be closed or ignored without review.
  2. We insist on high code quality. Please ensure your code is as good as, if not better than, the code written by frontier coding agents. Changes may be requested before your pull request can be merged.

Prek hooks

We use prek to run formatting and checks via git hooks.

Recommended setup:

  1. Run make prepare to sync dependencies and install the prek hooks.
  2. Optionally run on all files before sending a PR: prek run --all-files.

Manual setup (if you do not want to use make prepare):

  1. Install prek (pick one): uv tool install prek, pipx install prek, or pip install prek.
  2. Install the hooks in this repo: prek install.

After installation, the hooks run on every commit. The repo uses prek workspace mode, so only the projects with changed files run their hooks. You can skip them for an intermediate commit with git commit --no-verify, or run them manually with prek run --all-files.

The hooks execute the relevant make format-* and make check-* targets, so ensure dependencies are installed (make prepare or uv sync).