Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
104 lines (70 loc) · 5.08 KB

CONTRIBUTING.md

File metadata and controls

104 lines (70 loc) · 5.08 KB

Contributing to kimi-code

Thanks for taking the time to contribute! This project moves quickly, and thoughtful contributions from the community are what keep it sharp. The guide below walks you through how we work so your PR has the best chance of landing smoothly.

Before You Start

Kimi Code already has opinions on CLI/TUI behavior, agent workflows, and public APIs. If your change shifts that direction, open an issue first so we can align before you invest time in a PR.

We hold AI-assisted contributions to the same standard as hand-written ones. You should understand what you submit — what changed, how it behaves at the edges, and why it fits this codebase. If you cannot explain that, the PR is not ready for review.

We only merge PRs aligned with the roadmap. Drive-by refactors without context are unlikely to land.

Discuss first — open an issue before coding. PRs without prior discussion may be closed without review:

  • New features or user-visible behavior changes (regardless of size)
  • Refactors or other changes larger than ~100 lines
  • Public API or compatibility changes
  • Bug fixes where the cause or fix approach is still unclear

Can open a PR directly — link an existing issue when there is one:

  • Clear, reproducible bug fixes with a focused diff
  • Typos, documentation-only changes, and small CI/build fixes
  • Small changes that clearly match an existing issue or maintainer request

Project Layout

This is a pnpm monorepo. The most relevant entry points are:

  • apps/kimi-code — CLI / TUI
  • apps/vis — session replay & debugging visualizer
  • packages/node-sdk — public TypeScript SDK (@moonshot-ai/kimi-code-sdk)
  • packages/agent-core, kosong, kaos, oauth, telemetry — internal engine packages
  • docs/ — VitePress bilingual docs site

For the full project map, see AGENTS.md.

Development Setup

Prerequisites: Node.js >= 24.15.0, pnpm 10.33.0, Git.

git clone https://github.com/MoonshotAI/kimi-code.git
cd kimi-code
pnpm install

Useful scripts:

  • pnpm dev:cli — run the CLI in dev mode
  • pnpm test — run tests (vitest)
  • pnpm typecheck — TypeScript check (note: builds packages first)
  • pnpm lint — oxlint
  • pnpm lint:fix — oxlint with auto-fix
  • pnpm build — build all packages

Commit Convention

All commits and PR titles must follow Conventional Commits.

Type Use for Example
feat A new feature feat(agent-core): add tool dedup
fix A bug fix fix(tui): correct status bar alignment
docs Documentation only docs: clarify install instructions
chore Tooling / housekeeping chore: bump dependencies
refactor Internal refactor without behavior change refactor(kosong): extract retry helper
test Adding or improving tests test(agent-core): cover skill resolver
ci CI / build pipeline changes ci: cache pnpm store
build Build system / artifact changes build(native): add win32-arm64 target
perf Performance improvement perf(session): batch event flushes
style Formatting only (no logic) style: apply oxlint --fix

PR titles are enforced by the pr-title-checker workflow — a non-conforming title will block merge.

Changesets

This repo uses changesets to manage versioning and releases.

  • Every PR that affects release artifacts (code, behavior, public API) must include a changeset.
  • Docs-only, test-only, or CI-only PRs may skip changesets.
  • Generate one with pnpm changeset and follow the prompts (which packages are touched, which bump level).
  • For repo-specific conventions on package selection and bump levels, see .changeset/README.md. When working in this repo with coding agents, use the gen-changesets skill.

Pull Requests

Use the PR template when opening a feature pull request.

PR titles must follow Conventional Commits; CI runs pnpm lint, pnpm typecheck, and pnpm test on every PR. Update user-facing docs in docs/ when behavior changes — use the gen-docs skill when working with coding agents.

Code Style

  • TypeScript across the codebase.
  • Linting via oxlint (config in .oxlintrc.json).
  • Auto-formatting via pnpm lint:fix.
  • Follow existing local patterns when the lint rules do not cover a style choice.

Reporting Security Issues

Found a security issue? Please see SECURITY.md instead of opening a public issue.

License

By contributing to this repository, you agree that your contributions will be licensed under the MIT License.