docs(readme): add Prerequisites subsection to Development#2296
Open
ktwu01 wants to merge 1 commit into
Open
Conversation
The Development section opens with `make prepare` but never lists the tools a contributor needs installed first. New contributors hit `make: command not found`, `uv: command not found`, missing Node.js for `make build-web`, or — on Windows — a Shell tool that refuses to start because Git Bash isn't installed (GitBashNotFoundError). Make the prerequisites explicit so contributors don't have to read the Makefile, pyproject.toml, .python-version, and src/kimi_cli/utils/environment.py to figure them out. Fixes MoonshotAI#2274
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
This was referenced May 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
## Developmentsection opens withmake prepare, but neither the README norCONTRIBUTING.mdlists the tools a contributor needs installed first. New contributors hit one of:make: command not found(Windows without WSL / build-tools)uv: command not found(no link in the Development section)make build-webfailing because Node.js / npm isn't installedsrc/kimi_cli/utils/environment.py'sGitBashNotFoundError).python-versionpin vs.pyproject.toml's>=3.12This PR adds a
### Prerequisitessubsection at the top of## Developmentthat lists each tool with a one-line install pointer. The existingmake prepareline moves under a### Setupheading directly below.I deliberately did not hardcode the Python version into the README — the wording points to
.python-versionandpyproject.tomlso the prerequisite list won't rot when the pin moves.Test plan
make formatis a no-op on a docs-only change..python-versionsays3.14andpyproject.tomlsaysrequires-python = ">=3.12"— the README wording is consistent with both.src/kimi_cli/utils/environment.pydoes raiseGitBashNotFoundErroron Windows — the Git Bash bullet reflects real behavior, not folklore.Fixes #2274