docs: publish public ROADMAP.md - #15
Merged
Merged
Conversation
Vision, themes, and quarterly outlook for 2026 — saga pattern in Q2, new adapters in Q3 and Q4 (specifics deferred). Out-of-scope section to focus contributions; "How to influence" section pointing at Discussions and the new roadmap-input label. README updated to link ROADMAP and the upcoming docs site.
There was a problem hiding this comment.
Pull request overview
Publishes an initial public roadmap for Compendium and updates the README to point users to the roadmap and other documentation entry points.
Changes:
- Add a new public
ROADMAP.mddescribing vision, themes, near-term focus, and out-of-scope items. - Update README “Documentation” section to link to the roadmap, contributing guide, ADRs, and the upcoming DocFX site.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| ROADMAP.md | Introduces the public roadmap content (vision/themes/quarters/out-of-scope/how-to-influence). |
| README.md | Refreshes documentation links to include the roadmap and DocFX site. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### 2026 Q3 — New adapters | ||
|
|
||
| Additional adapters will be announced as the quarter approaches. Priorities are informed by Discussions and by demand signals from production deployments. If you have a strong need for a specific integration, please open a Discussion with the `roadmap-input` label. |
There was a problem hiding this comment.
GitHub Discussions don’t support issue labels, so “open a Discussion with the roadmap-input label” is not actionable as written. Suggest rephrasing to either (a) open an Issue with the roadmap-input label, or (b) open a Discussion and note that maintainers will create/label a tracking issue as roadmap-input.
Suggested change
| Additional adapters will be announced as the quarter approaches. Priorities are informed by Discussions and by demand signals from production deployments. If you have a strong need for a specific integration, please open a Discussion with the `roadmap-input` label. | |
| Additional adapters will be announced as the quarter approaches. Priorities are informed by Discussions and by demand signals from production deployments. If you have a strong need for a specific integration, please open a Discussion describing the use case; maintainers may create or label a tracking issue as `roadmap-input`. |
Contributor
Author
There was a problem hiding this comment.
Applied — see commit f47c8dc. Discussions don't carry labels, so the workflow is now: user opens a Discussion → maintainer creates/labels a tracking issue as roadmap-input.
GitHub Discussions don't support issue labels, so the previous wording "open a Discussion with the roadmap-input label" was not actionable. Reframe so users open a Discussion describing the use case, and clarify that maintainers may create or label a tracking *issue* as roadmap-input. Per Copilot reviewer feedback on PR #15.
4 tasks
Pomdapis
added a commit
that referenced
this pull request
Apr 26, 2026
## Summary PR #23 incorrectly bumped CHANGELOG to `[1.0.0-preview.2] - 2026-04-26` with the quality-sweep entries — but tag `v1.0.0-preview.2` was already cut on **2026-04-25** from a different commit set (PRs #1-7) and **already published to nuget.org** (`Compendium.Core 1.0.0-preview.2` is live). Reusing that version was a mistake. This PR reconciles the CHANGELOG with the published reality and rolls today's work into a new **preview.3**: ### `[1.0.0-preview.2] - 2026-04-25` — rewritten retroactively Now matches the auto-generated GitHub release notes for `v1.0.0-preview.2`: - **Added** — `Compendium.Adapters.Shared` (PII masking utilities, introduced in #3). - **Changed** — Dependabot bumps #4-7, OSS governance scaffolding. - **Security** — workflow `permissions:` block (#1), tenant log sanitization (#2), email removal from adapter logs / GDPR (#3). ### `[1.0.0-preview.3] - 2026-04-26` — new Everything since `v1.0.0-preview.2`: - **Added** — DocFX site (#17), 5 ADRs (#14), public ROADMAP (#15), getting-started guide (#20), 4 concept pages (#21), 8 adapter how-to guides (#22). - **Changed** — CodeQL Default Setup → `extended` query suite. - **Security** — `softprops/action-gh-release` pinned to commit SHA (#16, alert #28 closed). ## Test plan - [ ] CI green on this PR. - [ ] After merge, tag `v1.0.0-preview.3` triggers Release workflow successfully. - [ ] `Compendium.* @ 1.0.0-preview.3` published on nuget.org. - [ ] GitHub Release `v1.0.0-preview.3` created with auto-generated notes. VK: POM-186 (Code Quality sweep parent). Co-authored-by: sacha <sacha@scojhconsult.com>
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.
Summary
Adds the first public ROADMAP for Compendium. Closes POM-181.
Also updates the README "Documentation" section to point at ROADMAP.md and the upcoming DocFX site.
Test plan
ROADMAP.mdrenders cleanly on GitHubroadmap-inputlabel exists (`gh label list`)Notes for reviewer
This is intentionally non-committal on dates. The "no date here is a commitment" disclaimer is by design — see ADR 0005 for the philosophy on event-sourcing first; the same "ship when ready" applies to roadmap items.