Lesson 04
Package source another person can understand.
Create a minimal, clean archive with setup instructions, disclosure, limitations, and reproducible verification.
- Suggested time
- 30–45 minutes
- You will finish with
- A source ZIP that is useful after download and safe to inspect.
Make the README operational
Assume the recipient starts with only the extracted folder.
- List prerequisites with tested versions.
- Give exact install, run, test, and production-build commands.
- Explain the main flow, data storage, reset behavior, and known limitations.
Disclose what AI did
Separate author decisions from AI assistance without pretending the package was independently verified.
- Name the tools used and the kinds of work they assisted.
- State which journeys you personally exercised.
- Do not claim security, quality, originality, or production readiness beyond the evidence.
Archive only source
A clean Copy package excludes local state and machine-specific output.
- Exclude dependencies, build output, caches, logs, screenshots with personal data, .env files, credentials, and editor state.
- Include source, lockfiles, tests, README, and license notices.
- Extract into a fresh directory and rerun every setup command before publishing.
Copy-ready starter prompt
Replace the bracketed details, give it to your coding agent, and keep the verification steps intact.
Audit this project as if you received only its source ZIP. Create or improve README.md with prerequisites, exact setup/run/test/build commands, the primary journey, local data behavior, reset steps, AI-use disclosure, and honest limitations.
Define a package allowlist that includes source, tests, lockfiles, README, and license notices while excluding dependencies, build output, caches, logs, editor state, .env files, secrets, and personal data.
Build the archive, extract it into a fresh directory, run every documented command, scan it for secrets, and report file count, compressed/uncompressed size, checksums, test counts, and any remaining manual checks.Learn pages are public and anonymous. They do not create an account, a session, analytics, or marketplace activity.