feat(docs): add ROADMAP.md for OSSF Silver badge compliance by WilliamBerryiii · Pull Request #238 · microsoft/hve-core

WilliamBerryiii · 2026-01-22T03:03:43Z

Description

This PR adds a comprehensive project roadmap document to satisfy the OpenSSF Best Practices Badge Silver criterion documentation_roadmap. The roadmap outlines HVE Core priorities for 2026-2027 with explicit "Will Do" and "Won't Do" boundaries for each focus area.

Add 12-18 month roadmap covering agent framework evolution, instructions expansion, prompt engineering, enterprise readiness, documentation, and community ecosystem
Define success metrics with quantifiable targets for agent coverage, extension installs, and community engagement
Include timeline overview with quarterly milestones through Q1 2027
Extend commit message scopes to include (docs) for documentation-focused changes

Related Issue(s)

Fixes #236

Type of Change

Select all that apply:

Code & Documentation:

Bug fix (non-breaking change fixing an issue)
New feature (non-breaking change adding functionality)
Breaking change (fix or feature causing existing functionality to change)
Documentation update

Infrastructure & Configuration:

AI Artifacts:

Reviewed contribution with prompt-builder agent and addressed all feedback
Copilot instructions (.github/instructions/*.instructions.md)
Copilot prompt (.github/prompts/*.prompt.md)
Copilot agent (.github/agents/*.agent.md)

Note for AI Artifact Contributors:

Agents: Research, indexing/referencing other project (using standard VS Code GitHub Copilot/MCP tools), planning, and general implementation agents likely already exist. Review .github/agents/ before creating new ones.

Model Versions: Only contributions targeting the latest Anthropic and OpenAI models will be accepted. Older model versions (e.g., GPT-3.5, Claude 3) will be rejected.

See Agents Not Accepted and Model Version Requirements.

Other:

Script/automation (.ps1, .sh, .py)
Other (please describe):

Sample Prompts (for AI Artifact Contributions)

Not applicable. The instructions change adds a single scope entry (docs) to the allowed scopes list.

Testing

Validated ROADMAP.md renders correctly in GitHub preview
Verified frontmatter follows repository conventions
Confirmed commit message scope (docs) functions correctly

Checklist

Required Checks

Documentation is updated (if applicable)
Files follow existing naming conventions
Changes are backwards compatible (if applicable)

AI Artifact Contributions

Used /prompt-analyze to review contribution
Addressed all feedback from prompt-builder review
Verified contribution follows common standards and type-specific requirements

Required Automated Checks

The following validation commands must pass before merging:

Markdown linting: npm run lint:md
Spell checking: npm run spell-check
Frontmatter validation: npm run lint:frontmatter
Link validation: npm run lint:md-links
PowerShell analysis: npm run lint:ps

Security Considerations

This PR does not contain any sensitive or NDA information
Any new dependencies have been reviewed for security issues
Security-related scripts follow the principle of least privilege

Additional Notes

This roadmap satisfies the OpenSSF Best Practices Badge Silver criterion documentation_roadmap, which requires projects to document their plans for future development.

📋 - Generated by Copilot

- add project roadmap with 12-18 month priorities and scope boundaries - extend commit scopes to include docs 📋 - Generated by Copilot

github-actions · 2026-01-22T03:03:55Z

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

Copilot

Pull request overview

This PR adds a comprehensive ROADMAP.md document to satisfy the OpenSSF Best Practices Badge Silver criterion for documentation_roadmap. The roadmap outlines HVE Core's priorities for 2026-2027 and includes a minor update to commit message scopes.

Changes:

Added ROADMAP.md with 12-18 month project vision, success metrics, quarterly timeline, and explicit scope boundaries
Extended commit-message.instructions.md to include (docs) scope for documentation-focused commits

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
ROADMAP.md	Comprehensive 12-18 month roadmap covering agent framework, instructions, enterprise readiness, and community ecosystem with quarterly milestones and success metrics
.github/instructions/commit-message.instructions.md	Added `(docs)` to allowed commit message scopes list

docs/contributing/ROADMAP.md

.github/instructions/commit-message.instructions.md

docs/contributing/ROADMAP.md

…dering - relocate ROADMAP.md to reduce root directory congestion - alphabetize commit scope list placing docs after data 📋 - Generated by Copilot

katriendg

I LOVE it!
Wonder if we can put somewhere some focus on the work we want to do around MCP and tool invocation optimization, for industry evolving standards like the addition of SKILLS as means to improve context and loading of instructions/skills/tools dynamically.

Something like this Agent Framework Evolution section, using the word skills but without referring to the new agent skills standard as it may change:

* Optimize agent tool calling and dynamic loading of skills

WilliamBerryiii · 2026-01-22T20:21:31Z

I LOVE it! Wonder if we can put somewhere some focus on the work we want to do around MCP and tool invocation optimization, for industry evolving standards like the addition of SKILLS as means to improve context and loading of instructions/skills/tools dynamically.

Something like this Agent Framework Evolution section, using the word skills but without referring to the new agent skills standard as it may change:
* Optimize agent tool calling and dynamic loading of skills

Like this section?

### Agent Framework Evolution

**Will Do:**

* Expand MCP (Model Context Protocol) integration for standardized tool connections

codecov-commenter · 2026-01-22T20:23:27Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@b0e752c). Learn more about missing BASE report.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #238   +/-   ##
=======================================
  Coverage        ?   28.81%           
=======================================
  Files           ?       14           
  Lines           ?     2735           
  Branches        ?        0           
=======================================
  Hits            ?      788           
  Misses          ?     1947           
  Partials        ?        0

Flag	Coverage Δ
pester	`28.81% <ø> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

Copilot · 2026-01-22T20:26:08Z

docs/contributing/ROADMAP.md

+
+**Won't Do:**
+
+* Build a custom orchestration runtime; use LangGraph or similar established frameworks instead


This bullet point contains a complete sentence with imperative verb ("use LangGraph or similar established frameworks instead"). According to the markdown instructions, complete sentence bullet points should end with periods. Either rephrase as a fragment or add a period at the end.

Copilot · 2026-01-22T20:26:08Z

docs/contributing/ROADMAP.md

+**Won't Do:**
+
+* Build enterprise licensing or access control systems
+* Create centralized management infrastructure; organizations should use existing policy mechanisms


This bullet point contains a complete sentence ("organizations should use existing policy mechanisms"). According to the markdown instructions, complete sentence bullet points should end with periods. Either rephrase as a fragment or add a period at the end.

Copilot · 2026-01-22T20:26:09Z

docs/contributing/ROADMAP.md

+
+**Won't Do:**
+
+* Duplicate Azure documentation: link to authoritative sources instead


This bullet point contains a complete sentence with imperative verb ("link to authoritative sources instead"). According to the markdown instructions, complete sentence bullet points should end with periods. Either rephrase as a fragment or add a period at the end.

Copilot · 2026-01-22T20:26:09Z

docs/contributing/ROADMAP.md

+
+* Accept agents or instructions that don't align with project scope
+* Maintain community contributions without active maintainers
+* Build a separate community platform; use GitHub Discussions and Issues


This bullet point contains a complete sentence with imperative verb ("use GitHub Discussions and Issues"). According to the markdown instructions, complete sentence bullet points should end with periods. Either rephrase as a fragment or add a period at the end.

Copilot · 2026-01-22T20:26:09Z

.github/instructions/commit-message.instructions.md

+- `(data)`
+- `(docs)`


The PR description mentions adding the (docs) scope but doesn't mention reordering the (data) scope. The (data) scope is being moved from its position after (observability) to before (edge). If this reordering is intentional (perhaps for better logical grouping), it should be mentioned in the PR description. If it's unintentional, consider keeping (data) in its original location and only adding (docs).

🤖 I have created a release *beep* *boop* --- ## [2.0.0](hve-core-v1.1.0...hve-core-v2.0.0) (2026-01-28) ### ⚠ BREAKING CHANGES * **agents:** add Task Reviewer and expand RPI to 4-phase workflow ([#277](#277)) ### ✨ Features * **agents:** add hve-core-installer agent to extension package ([#297](#297)) ([c0e48c6](c0e48c6)) * **agents:** add Task Reviewer and expand RPI to 4-phase workflow ([#277](#277)) ([ae76cab](ae76cab)) * **build:** add code coverage reporting to Pester workflow ([#230](#230)) ([a34822a](a34822a)) * **docs:** add GOVERNANCE.md for OSSF Silver Badge compliance ([#235](#235)) ([b0e752c](b0e752c)) * **docs:** add ROADMAP.md for OSSF Silver badge compliance ([#238](#238)) ([4a41c16](4a41c16)) * **mcp:** add MCP server configuration guidance and installer enhancements ([#225](#225)) ([0bce418](0bce418)) * **scripts:** add YAML linting with actionlint ([#234](#234)) ([d9301f9](d9301f9)) * **security:** add OpenSSF Scorecard workflow and badge ([#271](#271)) ([7c6d788](7c6d788)) * **skills:** add video-to-gif conversion skill with FFmpeg two-pass optimization ([#247](#247)) ([8d65c42](8d65c42)) * **tests:** add Pester tests for LintingHelpers and Validate-MarkdownFrontmatter ([#197](#197), [#198](#198)) ([#205](#205)) ([51ae563](51ae563)) ### 🐛 Bug Fixes * **build:** detect table formatting changes via git diff ([#261](#261)) ([985eee0](985eee0)) * **build:** disable MD024 lint rule in CHANGELOG for release-please ([#220](#220)) ([971df94](971df94)) * **build:** quote shell variables and group redirects in workflow files ([#299](#299)) ([3372509](3372509)) * **build:** resolve scorecard badge and workflow security issues ([#301](#301)) ([aeaed13](aeaed13)) * **extension:** remove frontmatter from README and exclude from markdown linting ([#223](#223)) ([4272529](4272529)) * **instructions:** quote applyTo glob pattern for YAML compatibility ([#216](#216)) ([085199c](085199c)) * **scripts:** add FooterExcludePaths parameter to frontmatter validation ([#334](#334)) ([64db98d](64db98d)) * **scripts:** add GHSA word and logs/ exclusion to cspell config ([#214](#214)) ([5c99b3f](5c99b3f)) * **scripts:** correct type assertions in Invoke-YamlLint.Tests.ps1 ([#332](#332)) ([af7050d](af7050d)) * **scripts:** eliminate false positives in dependency pinning npm pattern ([#273](#273)) ([ccbdfa3](ccbdfa3)) * **security:** add artifact attestation for signed releases ([#257](#257)) ([c52d6e2](c52d6e2)) * standardize markdown footers and complete frontmatter ([#217](#217)) ([b4e7556](b4e7556)) ### 📚 Documentation * add OpenSSF Best Practices Passing badge to README ([#239](#239)) ([91bc529](91bc529)) * **architecture:** add architecture documentation and value proposition ([#252](#252)) ([0e4b02f](0e4b02f)) * **contributing:** add testing requirements for OSSF compliance ([#254](#254)) ([4db1a18](4db1a18)) * **docs:** add enterprise status badges to README header ([#270](#270)) ([ccb68a4](ccb68a4)) * **security:** add security assurance case and threat model for OSSF Silver ([#259](#259)) ([a390e26](a390e26)) ### ♻️ Refactoring * **application:** wrap execution with try blocks, ensure proper … ([#296](#296)) ([35c4417](35c4417)) * **scripts:** extract frontmatter validation to testable module ([#293](#293)) ([4e8707e](4e8707e)) * **scripts:** extract pure functions for Pester testability ([#221](#221)) ([d40e742](d40e742)) ### 🔧 Maintenance * **deps-dev:** bump cspell from 9.4.0 to 9.6.0 in the npm-dependencies group ([#208](#208)) ([855914b](855914b)) * **deps-dev:** bump cspell from 9.6.0 to 9.6.1 in the npm-dependencies group ([#294](#294)) ([1e45ad6](1e45ad6)) * **deps:** bump actions/setup-node from 6.1.0 to 6.2.0 in the github-actions group ([#209](#209)) ([c4c69e2](c4c69e2)) * **deps:** bump the github-actions group with 4 updates ([#295](#295)) ([d8337b8](d8337b8)) * remove step-security/harden-runner from workflows ([#246](#246)) ([c5708d8](c5708d8)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: hve-core-release-please[bot] <254602402+hve-core-release-please[bot]@users.noreply.github.com>

feat(docs): add ROADMAP.md for OSSF Silver badge compliance

3284ac1

- add project roadmap with 12-18 month priorities and scope boundaries - extend commit scopes to include docs 📋 - Generated by Copilot

WilliamBerryiii requested a review from a team as a code owner January 22, 2026 03:03

Copilot AI review requested due to automatic review settings January 22, 2026 03:03

Copilot started reviewing on behalf of WilliamBerryiii January 22, 2026 03:04 View session

Copilot AI reviewed Jan 22, 2026

View reviewed changes

docs/contributing/ROADMAP.md Show resolved Hide resolved

docs/contributing/ROADMAP.md Show resolved Hide resolved

.github/instructions/commit-message.instructions.md Outdated Show resolved Hide resolved

docs/contributing/ROADMAP.md Show resolved Hide resolved

refactor(docs): move ROADMAP.md to docs/contributing and fix scope or…

6d3dca4

…dering - relocate ROADMAP.md to reduce root directory congestion - alphabetize commit scope list placing docs after data 📋 - Generated by Copilot

katriendg approved these changes Jan 22, 2026

View reviewed changes

Merge branch 'main' into docs/236-add-roadmap

983f8b8

Copilot AI review requested due to automatic review settings January 22, 2026 20:21

Copilot started reviewing on behalf of WilliamBerryiii January 22, 2026 20:22 View session

WilliamBerryiii merged commit 4a41c16 into main Jan 22, 2026
20 checks passed

WilliamBerryiii deleted the docs/236-add-roadmap branch January 22, 2026 20:24

hve-core-release-please bot mentioned this pull request Jan 22, 2026

chore(main): release hve-core 2.0.0 #212

Merged

Copilot AI reviewed Jan 22, 2026

View reviewed changes

This was referenced Jan 28, 2026

chore(main): release hve-core 3.0.0 #341

Closed

chore(main): release hve-core 3.0.0 #417

Closed

This was referenced Feb 6, 2026

chore(main): release hve-core 3.0.0 #441

Closed

chore(main): release hve-core 3.0.0 #530

Closed

chore(main): release hve-core 3.0.0 #532

Closed

chore(main): release hve-core 3.0.0 #534

Closed

hve-core-release-please bot mentioned this pull request Feb 17, 2026

chore(main): release hve-core 3.0.0 #641

Closed


		Won't Do:

		* Build a custom orchestration runtime; use LangGraph or similar established frameworks instead


		Won't Do:

		* Duplicate Azure documentation: link to authoritative sources instead

Conversation

WilliamBerryiii commented Jan 22, 2026

Description

Related Issue(s)

Type of Change

Sample Prompts (for AI Artifact Contributions)

Testing

Checklist

Required Checks

AI Artifact Contributions

Required Automated Checks

Security Considerations

Additional Notes

Uh oh!

github-actions bot commented Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Dependency Review

Scanned Files

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

katriendg left a comment

Choose a reason for hiding this comment

Uh oh!

WilliamBerryiii commented Jan 22, 2026

Uh oh!

codecov-commenter commented Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented Jan 22, 2026 •

edited

Loading

codecov-commenter commented Jan 22, 2026 •

edited

Loading