ORD Ship
Invoke as $ord-ship.
Rapid shipping for ORD packages. Publishes to npm, creates a developer-friendly README, sets up the GitHub repo, and appends to the running ship log.
Process
- Pre-flight: Confirm the package is ready to publish.
- Read the ord-align doc for scope, package name, and API surface.
- Run the build and tests. Fix blockers.
- Verify the core API works as documented.
- Check
package.json has correct name, version, description, keywords, license, and repository fields.
- Ensure
files or .npmignore is configured to publish only intended files.
- README: Create or verify
README.md with:
- Package name and one-line description
- Install command (
npm install <name>)
- Quick start (3-10 lines showing the primary use case)
- API reference (brief — each exported function/command with signature and one-line description)
- License
- Publish to npm:
- Run
npm publish (or npm publish --access public for scoped packages).
- Verify the package appears on npmjs.com.
- If publish fails due to auth, report the blocker and provide the manual command.
- GitHub repo setup:
- Ensure the repo has a description, topics/tags, and the homepage URL set.
- Add a
.github/FUNDING.yml if the user has sponsorship configured.
- Ship log: Append entry to
research/ord-ship-log.md:
- Date, package name, npm URL, GitHub URL
- Tech stack used
- Build time (estimated hours)
- v1 API surface summary
- Success metric from alignment doc
- Status:
published
- Distribution: Execute launch-day distribution:
- Identify relevant channels: dev Twitter, Reddit r/node or r/javascript, HN Show, relevant Discord servers
- Draft a launch post (the user posts it manually)
Output
End with:
**Shipped:** <package name> — <npm URL>
**Next work:** monitor adoption for 1-2 weeks, then run the ORD traction gate before any Devtool AFPS graduation decision
**Recommended next command:** $ord-traction (after monitoring) or $ord-scan (next experiment)
Constraints
- Do not gold-plate. Ship the minimum useful version.
- Do not run
npm publish without user confirmation if this is the first publish for this package.
- Do not modify unrelated packages or repositories.
- If npm auth is not configured, provide the manual publish command and stop.
- Create
research/ord-ship-log.md with a header if it doesn't exist.
Default Shipping Contract
Follow the shared shipping contract convention.
1---2name: ord-ship3description: Publish to npm, create README, set up repo, and log the shipment4---56# ORD Ship78Invoke as `$ord-ship`.910Rapid shipping for ORD packages. Publishes to npm, creates a developer-friendly README, sets up the GitHub repo, and appends to the running ship log.1112## Process13141. **Pre-flight:** Confirm the package is ready to publish.15 - Read the ord-align doc for scope, package name, and API surface.16 - Run the build and tests. Fix blockers.17 - Verify the core API works as documented.18 - Check `package.json` has correct name, version, description, keywords, license, and repository fields.19 - Ensure `files` or `.npmignore` is configured to publish only intended files.202. **README:** Create or verify `README.md` with:21 - Package name and one-line description22 - Install command (`npm install <name>`)23 - Quick start (3-10 lines showing the primary use case)24 - API reference (brief — each exported function/command with signature and one-line description)25 - License263. **Publish to npm:**27 - Run `npm publish` (or `npm publish --access public` for scoped packages).28 - Verify the package appears on npmjs.com.29 - If publish fails due to auth, report the blocker and provide the manual command.304. **GitHub repo setup:**31 - Ensure the repo has a description, topics/tags, and the homepage URL set.32 - Add a `.github/FUNDING.yml` if the user has sponsorship configured.335. **Ship log:** Append entry to `research/ord-ship-log.md`:34 - Date, package name, npm URL, GitHub URL35 - Tech stack used36 - Build time (estimated hours)37 - v1 API surface summary38 - Success metric from alignment doc39 - Status: `published`406. **Distribution:** Execute launch-day distribution:41 - Identify relevant channels: dev Twitter, Reddit r/node or r/javascript, HN Show, relevant Discord servers42 - Draft a launch post (the user posts it manually)4344## Output4546End with:4748```md49**Shipped:** <package name> — <npm URL>50**Next work:** monitor adoption for 1-2 weeks, then run the ORD traction gate before any Devtool AFPS graduation decision51**Recommended next command:** $ord-traction (after monitoring) or $ord-scan (next experiment)52```5354## Constraints5556- Do not gold-plate. Ship the minimum useful version.57- Do not run `npm publish` without user confirmation if this is the first publish for this package.58- Do not modify unrelated packages or repositories.59- If npm auth is not configured, provide the manual publish command and stop.60- Create `research/ord-ship-log.md` with a header if it doesn't exist.6162## Default Shipping Contract6364Follow the shared shipping contract convention.
GeorgeQLe