Add roadmap template next to the issue forms - #33
Open
rahlk wants to merge 1 commit into
Open
Conversation
The roadmap skeleton lived as prose inside a fenced block in a cldk-devtools skill reference -- not copyable, not where the artifact lands, and with editorial voice baked into the section headings. Move it here as a real file, sibling to ISSUE_TEMPLATE/ and CONTRIBUTING, on the same principle issue bodies already follow: the template lives in the org repo, the skill links it. Roadmaps are committed to this repo anyway. Skeleton is placeholders plus a one-line HTML-comment hint per section, so the guidance disappears when the file is filled in rather than shipping in every copy.
9 tasks
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.
Adds
docs/design/roadmap-template.md.Motivation and Context
The roadmap skeleton lived as prose inside a fenced code block in a
cldk-devtoolsskill reference. Three problems: you can't copy it, it isn't where the artifact actually lands, and editorial voice was baked into the section headings ("The list that makes the rest mean something", "ride one migration, not one each") so every roadmap inherited my phrasing.Moves it here as a real file, sibling to
ISSUE_TEMPLATE/andCONTRIBUTING.md, on the principle issue bodies already follow — template lives in the org repo, the skill links it. Roadmaps are committed to this repo regardless.How Has This Been Tested?
Not executable. Markdown renders; the HTML-comment hints are stripped by GitHub's renderer, so a filled-in roadmap shows only its own content.
Breaking Changes
No. New file. The
cldk-devtoolsside is a follow-up that points its skill reference here.Types of changes
Checklist
Additional context
Guidance is one-line HTML comments rather than prose, so it vanishes on fill-in instead of shipping in every copy. Sections are unchanged in substance: Candidates, Collision groups, Dependency order, Release trains, Not now, Starting now.
One instruction kept in the header because it is a real constraint rather than commentary: one roadmap, amended in place, never a second file.