Changelog
Français · Type: reference · Audience: player, admin, author, contributor · Context: player's browser, engine repository, created project, hosted Studio, Reality Bridge · Status: ready · Applies from: 4.5.0
What changed in each release of quest-n-click is in one file, CHANGELOG.md, at the root of
the repository. This page does not copy it: it says where to read it and how to read it.
Where to read it
- In the repository:
CHANGELOG.md, newest release first, one## <version> — <date>section per release. - On GitHub: each release's notes, at https://github.com/wanoo/quest-n-click/releases.
- Not in the npm package: an installed engine (
node_modules/quest-n-click/) does not carryCHANGELOG.md.
How to read a release's section
- The opening paragraph: the release's name and what it is for, and whether a game has anything to change.
### Breaking: what a game, a host or a script must change. Since 4.2.0 a minor version adds and never removes; a removal waits for the next major (start.stability).### Fixed: the bugs fixed, each with the version and, when there is one, its issue number.### Changes: what was added or changed without breaking.- How to move a game from one version to the next is not in the changelog: see install.upgrade and the upgrade notes of each line.
What is not released yet
In the engine repository, a branch that changes the code writes its changelog lines as a fragment,
changes/<slug>.md; they are gathered under Unreleased in CHANGELOG.md when the branch reaches main
(npm run changes -- --assemble, tools/changes.ts). Until a release, what main holds
beyond the last version is in changes/ and that Unreleased block. How a release is cut: contribute.releasing.