Add MIT license, contributing guide, CLAUDE.md, architecture notes and repo skills
This commit is contained in:
parent
06576357c9
commit
443202876a
10 changed files with 457 additions and 1 deletions
55
.claude/skills/release/SKILL.md
Normal file
55
.claude/skills/release/SKILL.md
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
---
|
||||
name: release
|
||||
description: Cut and ship a Series of Tubes release (patch or minor) from main via the auto-release workflow.
|
||||
---
|
||||
|
||||
# Releasing Series of Tubes
|
||||
|
||||
Bumping `version` in `package.json` on `main` is the release button. The
|
||||
`auto-release.yml` workflow tests, tags `v<version>`, publishes a GitHub release with
|
||||
that version's CHANGELOG section as notes, and dispatches `release.yml`, which deploys
|
||||
to GitHub Pages (https://seriesoftub.es).
|
||||
|
||||
## Pick the version
|
||||
|
||||
- Patch (`x.y.Z`): fixes, small tweaks, wording, icons.
|
||||
- Minor (`x.Y.0`): new features or content.
|
||||
|
||||
## Steps
|
||||
|
||||
1. Make sure `main` is green: `npm test` and `node scripts/i18n-check.js`
|
||||
("0 missing, 0 unused, 0 broken").
|
||||
2. In `CHANGELOG.md`, move the bullets from `## [Unreleased]` into a new section
|
||||
right below it: `## [x.y.z] — YYYY-MM-DD` (em dash, today's date). Keep an empty
|
||||
`## [Unreleased]` heading above it. The build fails if the section has no bullets.
|
||||
3. Bump the version in **both** files:
|
||||
- `package.json` → `"version"`
|
||||
- `package-lock.json` → top-level `"version"` and `packages[""].version`
|
||||
4. `npm test` once more.
|
||||
5. Commit on `main` as Frederic, with no attribution trailers:
|
||||
```bash
|
||||
git -c user.name="Frederic Jung" -c user.email="frederic@jc-ix.net" commit \
|
||||
--author="Frederic Jung <frederic@jc-ix.net>" -m "Short summary (x.y.z)"
|
||||
git push origin main
|
||||
```
|
||||
6. Watch the workflows until both finish:
|
||||
```bash
|
||||
gh run list --repo fjaeckel/seriesoftubes --limit 4
|
||||
gh run watch <id> --repo fjaeckel/seriesoftubes
|
||||
```
|
||||
7. Confirm it is live: `https://seriesoftub.es/version.json` shows the new version.
|
||||
|
||||
## Release notes rules
|
||||
|
||||
- Written for players, in plain English. One bullet per change, issue numbers like `(#37)`.
|
||||
- Never mention hidden easter eggs or explain jokes.
|
||||
- No internal function names.
|
||||
|
||||
## If something fails
|
||||
|
||||
- "not newer than the latest release": the version was not bumped, or was bumped
|
||||
backwards.
|
||||
- "CHANGELOG.md has no notes under ## [x.y.z]": the heading doesn't match the version
|
||||
exactly or has no bullets.
|
||||
- Tests fail in the workflow but pass locally: look for unseeded randomness in a test.
|
||||
- Fix forward with a new patch version; never move or delete an existing tag.
|
||||
Loading…
Add table
Add a link
Reference in a new issue