docs(roadmap): reorganise [Unreleased] before tagging 2.0.0 stable - #113
Merged
Conversation
Raised by Zip on noticing that no release candidate has a section of its own. That is deliberate and documented — a rc leaves [Unreleased] open, only a stable freezes it — and it stays the right model. The side effect is not: [Unreleased] has passed 1450 lines, stacked lot by lot in arrival order, and the stable tag will freeze that block as the version's reference section. So the moment to reorganise it is before the tag. Recorded as an idea, not a lot: nothing is decided about the shape, and every lot merged until then adds to it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Reviewer's GuideDocuments a planned reorganization of the Flow diagram for CHANGELOG
|
| Change | Details | Files |
|---|---|---|
Add roadmap entry describing how and why to reorganize the long [Unreleased] CHANGELOG section prior to the 2.0.0 stable release, keeping decisions explicitly open. |
|
dev/roadmap.md |
Tips and commands
Interacting with Sourcery
- Trigger a new review: Comment
@sourcery-ai reviewon the pull request. - Continue discussions: Reply directly to Sourcery's review comments.
- Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with@sourcery-ai issueto create an issue from it. - Generate a pull request title: Write
@sourcery-aianywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai titleon the pull request to (re-)generate the title at any time. - Generate a pull request summary: Write
@sourcery-ai summaryanywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment@sourcery-ai summaryon the pull request to
(re-)generate the summary at any time. - Generate reviewer's guide: Comment
@sourcery-ai guideon the pull
request to (re-)generate the reviewer's guide at any time. - Resolve all Sourcery comments: Comment
@sourcery-ai resolveon the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore. - Dismiss all Sourcery reviews: Comment
@sourcery-ai dismisson the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai reviewto trigger a new review!
Customizing Your Experience
Access your dashboard to:
- Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others. - Change the review language.
- Add, remove or edit custom review instructions.
- Adjust other review settings.
Getting Help
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- The paragraph mentioning "tout ce qui s'est accumulé depuis la 2.0.0 du 6 juillet" is a bit confusing given that 2.0.0 stable is described as not yet tagged; consider rephrasing to clarify the timeline (e.g. since the first 2.0.0 pre-release).
- You might want to add a direct anchor or section reference to the relevant part of
docs/developer/workflow.mdso readers can quickly jump to the workflow rules you’re summarising here.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The paragraph mentioning "tout ce qui s'est accumulé depuis la 2.0.0 du 6 juillet" is a bit confusing given that 2.0.0 stable is described as not yet tagged; consider rephrasing to clarify the timeline (e.g. since the first 2.0.0 pre-release).
- You might want to add a direct anchor or section reference to the relevant part of `docs/developer/workflow.md` so readers can quickly jump to the workflow rules you’re summarising here.
## Individual Comments
### Comment 1
<location path="dev/roadmap.md" line_range="103" />
<code_context>
+ce bloc se fige tel quel et devient la section de référence de la version — donc le moment de le
+réorganiser est **avant** le tag, pas après.
+
+Pistes à instruire (aucune tranchée) : regrouper par thème plutôt que par ordre d'arrivée
+(Added / Changed / Fixed à la « Keep a Changelog », ou par domaine CTLD : troupes, caisses, JTAC,
+outil…) ; fusionner les entrées qui se corrigent l'une l'autre entre deux rc, un lecteur de la
</code_context>
<issue_to_address>
**issue (typo):** “aucune tranchée” semble être une coquille ou un mauvais choix de mot dans ce contexte.
La formulation actuelle ne reflète pas clairement l’idée qu’aucune décision n’est encore prise. Je suggère de reformuler, par exemple en « rien n’est tranché » ou « aucune piste n’est tranchée », pour rendre l’intention explicite.
```suggestion
Pistes à instruire (rien n'est tranché) : regrouper par thème plutôt que par ordre d'arrivée
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| ce bloc se fige tel quel et devient la section de référence de la version — donc le moment de le | ||
| réorganiser est **avant** le tag, pas après. | ||
|
|
||
| Pistes à instruire (aucune tranchée) : regrouper par thème plutôt que par ordre d'arrivée |
There was a problem hiding this comment.
issue (typo): “aucune tranchée” semble être une coquille ou un mauvais choix de mot dans ce contexte.
La formulation actuelle ne reflète pas clairement l’idée qu’aucune décision n’est encore prise. Je suggère de reformuler, par exemple en « rien n’est tranché » ou « aucune piste n’est tranchée », pour rendre l’intention explicite.
Suggested change
| Pistes à instruire (aucune tranchée) : regrouper par thème plutôt que par ordre d'arrivée | |
| Pistes à instruire (rien n'est tranché) : regrouper par thème plutôt que par ordre d'arrivée |
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
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
Zip asked whether it was normal that no release candidate has a
CHANGELOGsection of its own, everything living in[Unreleased].It is, and it is written down:
workflow.mdsays a pre-release leaves[Unreleased]open while only a stable freezes it into## [x.y.z] — date. The file bears it out — three version sections in total ([Unreleased],[2.0.0],[1.x] Legacy), none for the six rc. And it stays the right model: a rc is a step towards 2.0.0, not a shipped version, and splitting into[2.0.0-rc1]…[2.0.0-rcN]would force a reader to reassemble seven sections to learn what 2.0.0 brings. Each rc's own notes already live on its GitHub release page.The side effect is real, though:
[Unreleased]has passed 1450 lines — everything accumulated since 2.0.0 on 6 July, stacked lot by lot in arrival order. The stable tag will freeze that block as the version's reference section, so the moment to reorganise it is before the tag.What this PR does
Records it in
dev/roadmap.mdas an idea, with the options left open (group by theme rather than arrival order; merge entries that correct one another between two rc; decide whether implementation detail belongs in a file Mission Makers read). No lot, no decision — the shape is not settled, and every lot merged until then adds to it.🤖 Generated with Claude Code
Summary by Sourcery
Documentation:
[Unreleased]changelog section ahead of the 2.0.0 stable release.