docs(dod): specify CHANGELOG Unreleased placement#48
Merged
Conversation
![ben-s-pull-request-reviewer[bot]](https://avatars.githubusercontent.com/u/1193284?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Prompt 159 (the
work-on--non-interactivefix) produced a malformed CHANGELOG: the container agent, told only "add an entry under## Unreleased", created that section above the preamble (there was no existing## Unreleased). The autoRelease bot then renamed it in place, shipping a broken structure in v0.96.2 (since fixed on master). Root cause: the DoD never specified where to create## Unreleased.What
docs/dod.md: the CHANGELOG line now mandates placement —## Unreleasedgoes below the preamble and above the newest## vX.Y.Z, never above the preamble. Canonical order spelled out.docs/ships as a plugin doc, so this is under## Unreleasedfor the autoRelease bot.Follow-up (optional, not in this PR)
A CHANGELOG-structure check in
make precommitwould catch this mechanically (defense in depth) — that's a code change; happy to do it as a separate dark-factory prompt if wanted.