MoonshotAI / MoonshotAI/kimi-code
Workspace layout: ignored directories (dist/, build/, node_modules/, scratch/)
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 7.5k
- Forks
- 1.2k
- Avg merge
- 11h 53m
- Merged PRs (30d)
- 350
Description
Question
Establish the three-zone workspace layout:
| Zone | Directory | Committed | Rebuilt | Lifetime |
|---|---|---|---|---|
| Source | src/, docs/, tests/, assets/ |
Yes | Never | Permanent |
| Output | dist/, build/, target/, node_modules/ |
No | Always | Until next build |
| Scratch | scratch/ |
No | Never | Disposable |
Key rules:
- Output is ignored because it is derived. Committing build artifacts creates a second source of truth.
- Scratch is ignored because it is private. Give it a
README.mdthat survives the ignore rule. - The defining test: deleting
scratch/entirely must never break the repository, the build, or the documentation.
Decision needed: Configure .gitignore for these zones. Create scratch/README.md explaining the convention. Ensure dist/, build/, node_modules/ are ignored.
Label: wayfinder:task
Part of #2517
Blocks: #2518
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the repository’s .gitignore and existing workspace documentation, then review the requested source, output, and scratch zones. Add the ignore rules and scratch/README.md described in the issue, and verify that deleting scratch/ does not break the repository, build, or documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 82/100