MoonshotAI / MoonshotAI/kimi-code

Packaging conventions (build from src/, stage, validate, package)

Open
#2,525 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

Establish packaging conventions:

  • The package is built from src/, never assembled by hand. A hand-assembled package is correct exactly once.
  • Build into dist/, from a clean staging directory. Staging exists so the package contains what the format requires and nothing else:
rm -rf stage && mkdir -p stage
cp -r src/<artifact> stage/
<validate>            # Format check before packaging, not after.
<package> stage/<artifact> dist/
rm -rf stage
  • The build command lives in the repository, in scripts/ when more than a couple of lines, and in docs/how-to/release.md either way.
  • Version in exactly one place. Wherever the format keeps it — package manifest, frontmatter, module constant. Every other mention is derived or a duplicate waiting to go stale. CHANGELOG.md is the human-readable projection.

Decision needed: Document build process, create staging scripts, ensure version single-source-of-truth.

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 existing src/ tree, scripts/, docs/how-to/release.md, package manifest, and CHANGELOG.md to identify current packaging and version locations. Establish the documented build flow through a clean staging directory, add scripts where needed, and ensure the package format is validated before packaging with one source of truth for the version.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
build-system, documentation, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.