Release only when there is something worth shipping
This commit is contained in:
parent
683b7bad3c
commit
95cb4eeb7c
2 changed files with 9 additions and 1 deletions
|
|
@ -10,6 +10,14 @@ Bumping `version` in `package.json` on `main` is the release button. The
|
||||||
that version's CHANGELOG section as notes, and dispatches `release.yml`, which deploys
|
that version's CHANGELOG section as notes, and dispatches `release.yml`, which deploys
|
||||||
to GitHub Pages (https://seriesoftub.es).
|
to GitHub Pages (https://seriesoftub.es).
|
||||||
|
|
||||||
|
## Not everything needs a release
|
||||||
|
|
||||||
|
Release only when there is something worth shipping to players: a feature, a fix they
|
||||||
|
will notice, or a decent batch of smaller changes. Docs, skills, CI, issue templates,
|
||||||
|
tests and refactors never need a release on their own; just push them. Small
|
||||||
|
player-facing tweaks can sit under `## [Unreleased]` until a real release comes along.
|
||||||
|
Don't plan a release just because the hour is up, and when unsure, ask the user.
|
||||||
|
|
||||||
## At most one release per hour
|
## At most one release per hour
|
||||||
|
|
||||||
Players get an update banner and a "What's new" window for every release, so ship at
|
Players get an update banner and a "What's new" window for every release, so ship at
|
||||||
|
|
|
||||||
|
|
@ -28,7 +28,7 @@ To play during development, open `site/index.html` directly or run `npm run serv
|
||||||
or any other attribution trailers.
|
or any other attribution trailers.
|
||||||
- **Releases** happen by bumping `version` in `package.json` on `main` (see the
|
- **Releases** happen by bumping `version` in `package.json` on `main` (see the
|
||||||
`release` skill). Small fixes or tweaks get a patch release (`x.y.Z`); new features a
|
`release` skill). Small fixes or tweaks get a patch release (`x.y.Z`); new features a
|
||||||
minor release. **At most one release per hour**: until the hour is up, push work with
|
minor release. **Not everything needs a release**: docs, skills, CI, tests and refactors are just pushed, and small player-facing tweaks wait under `## [Unreleased]` for a real release. **At most one release per hour**: until the hour is up, push work with
|
||||||
its CHANGELOG bullets under `## [Unreleased]` and batch it into the next release. Only a
|
its CHANGELOG bullets under `## [Unreleased]` and batch it into the next release. Only a
|
||||||
broken live game justifies an immediate hotfix.
|
broken live game justifies an immediate hotfix.
|
||||||
- **Release notes in the app are short**: only the first sentence of each CHANGELOG bullet
|
- **Release notes in the app are short**: only the first sentence of each CHANGELOG bullet
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue