MoonshotAI / MoonshotAI/kimi-code

Root directory cleanup

Open
#2,519 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
7.5k
Forks
1.2k
Avg merge
11h 53m
Merged PRs (30d)
350

Description

Question

The root directory should only contain two categories of files:

  1. Tool-mandated: Files that are only found if they sit at the top: .gitignore, package.json, pyproject.toml, Cargo.toml, Makefile, CI configuration under .github/, editor configuration.

  2. Community health files: README.md, LICENSE, CHANGELOG.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, CITATION.cff (research projects only).

Current root has many extra files: AGENTS.md, CLAUDE.md (symlink), CONTRIBUTING.md, GOAL.md, IMAGE_LIMIT_PATCH.md, README.zh-CN.md, flake.lock, flake.nix, tsconfig.json, vitest.config.ts, pnpm-lock.yaml, pnpm-workspace.yaml, .editorconfig, .gitattributes, .npmrc, .nvmrc, .oxfmtrc.json, .oxlintrc.json.

Decision needed: Which of these are tool-mandated and must stay at root? Which should move to docs/, scripts/, or be archived? The conventions say "Everything else moves out. A plan document, a spec, a task list, or a set of notes in the root is the single clearest sign of a repository that grew without a scheme."

Label: wayfinder:task
Part of #2517
Blocks: #2518

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the listed root files and the repository conventions, then inspect the roles of tsconfig.json, vitest.config.ts, pnpm-workspace.yaml, and the other configuration and notes files. Done means producing the requested classification and an agreed plan for files that stay, move to docs/ or scripts/, or are archived, while considering the dependency on #2517 and blocker #2518.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
build-system, developer-experience, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.