daikaginza
114b0eeaba
`CONTRIBUTING.md` asks every runtime change to add an entry at the top of `CHANGELOG.md`, so two pull requests in flight write into the same few lines and git has nothing to merge on. Against `main` at `81eb443`, `git merge-tree` over the 85 open pull requests GitHub reports as conflicting that aren't mine puts `CHANGELOG.md` in the conflict set of 41 — more than any other path — and for 6 it is the only one. `docs/CURRENT-STATE.md`, the other file rule 3 names, conflicts for 23, and merges cleanly for 23 of the 41: edits land in the section for the area you touched, so they only collide when the areas do. A pull request now adds `changelog.d/<pull request>-<slug>.md` instead. Distinct filenames never conflict, and the pull request number makes them distinct for free. `npm run changelog` splices the directory into `CHANGELOG.md` and empties it; `npm run changelog:check` reports the batch and changes nothing. Fragment text is copied through unchanged apart from trailing whitespace. `src/annotations/drawTool.test.mjs` reads `CHANGELOG.md` as prose and slices a fixed window after a heading, so an assembler that reflowed an entry could move text across that window. Fragments are deliberately outside `scripts/format-scope.json` for the same reason. The assembler refuses a batch before writing anything when a filename is not `<pull request>-<slug>.md` or two fragments claim one pull request number, and a unit test runs that check over the real `changelog.d/`, so a fragment the release could not assemble fails `npm test` in the pull request that adds it rather than at release time. Refs #781.
1.8 KiB
Changelog fragments
One file per entry. A pull request adds a file here instead of editing
CHANGELOG.md, and a release concatenates them into it.
changelog.d/<pull request number>-<slug>.md
723-atc-decision-layer.md, for example. The slug is lowercase, words separated
by -. Two pull requests never pick the same filename, because the pull request
number is already unique — which is the point: new CHANGELOG.md entries go at
the top of the file, so two pull requests in flight write into the same few lines
and git has nothing to merge on.
Write the file exactly as the entry should read in CHANGELOG.md: a - bullet,
wrapped the way the surrounding entries are, crediting yourself and the pull
request.
- Report which upstream declined a Street Traffic road load. The layer row now
reads `Overpass rate-limited` instead of a general "Road data temporarily
unavailable" (yourname, #665).
The text is spliced in unchanged apart from trailing whitespace, so what you
write here is what ships. Fragments are deliberately outside
scripts/format-scope.json, so npm run format never reflows one.
At release time:
npm run changelog:check # list what would move, change nothing
npm run changelog # move every fragment into CHANGELOG.md
The assembler refuses a batch rather than guessing: a filename that is not
<pull request>-<slug>.md, or two fragments claiming one pull request number,
stops the run before anything is written and names the files.
A documentation claim that needs a regression test — the way
src/annotations/drawTool.test.mjs asserts against CHANGELOG.md — should
assert against docs/CURRENT-STATE.md or README.md instead. A pull request
still edits those directly, so the text is in the file while the change is under
review; a fragment does not reach CHANGELOG.md until release.