docs: align CONTRIBUTING.md with docs/contributing/ guides#445
Merged
WilliamBerryiii merged 5 commits intomainfrom Feb 10, 2026
Merged
docs: align CONTRIBUTING.md with docs/contributing/ guides#445WilliamBerryiii merged 5 commits intomainfrom
WilliamBerryiii merged 5 commits intomainfrom
Conversation
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
- add AI Artifact Contributions section with links to all artifact guides - update Improving The Documentation section to reference AI artifacts - expand validation commands list with all npm scripts - reconcile release process content (delegate to detailed guide) - add Finding the Right Guide navigation table to docs/contributing/README.md - update ms.date to 2026-02-06 in both files 📚 - Generated by Copilot Co-authored-by: WilliamBerryiii <4399970+WilliamBerryiii@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Align CONTRIBUTING.md with docs/contributing guides
docs: align CONTRIBUTING.md with docs/contributing/ guides
Feb 6, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #445 +/- ##
==========================================
- Coverage 76.22% 76.19% -0.03%
==========================================
Files 20 20
Lines 3503 3503
==========================================
- Hits 2670 2669 -1
- Misses 833 834 +1
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Aligns top-level contribution docs with the more detailed docs/contributing/ hub so contributors can discover the right guidance regardless of entry point.
Changes:
- Adds cross-navigation between
CONTRIBUTING.mdanddocs/contributing/(including an AI artifact contributions section + navigation table). - Expands local validation command documentation and delegates artifact-specific details to common standards.
- Refreshes release-process summary formatting and updates
ms.datemetadata.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/contributing/README.md | Adds a “Finding the Right Guide” table that links intents to the appropriate contribution docs. |
| CONTRIBUTING.md | Adds an AI artifact contribution section, expands validation script list, and refactors the release-process summary with links to detailed guides. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- keep both AI Artifact Contributions and Pull Request Inactivity Policy sections - use newer ms.date from main (2026-02-07) - include both TOC entries 🔀 - Generated by Copilot
agreaves-ms
approved these changes
Feb 10, 2026
WilliamBerryiii
pushed a commit
that referenced
this pull request
Feb 13, 2026
🤖 I have created a release *beep* *boop* --- ## [2.3.0](hve-core-v2.2.0...hve-core-v2.3.0) (2026-02-13) ### ✨ Features * **agents:** add GitHub backlog management pipeline ([#448](#448)) ([2b4d123](2b4d123)) * **docs:** define inactivity closure policies for issues and PRs ([#452](#452)) ([5e710fd](5e710fd)) * **extension:** implement collection-based plugin distribution system ([#439](#439)) ([3156d98](3156d98)) * **instructions:** replace EVEN/ODD hardcoding with runtime milestone discovery protocol ([#486](#486)) ([ae95eb2](ae95eb2)) * **plugin:** support Copilot CLI plugin generation from collection manifests ([#496](#496)) ([e6cee85](e6cee85)) * **scripts:** enhance on-create.sh to install actionlint and PowerShell modules ([#500](#500)) ([67585f5](67585f5)) ### 🐛 Bug Fixes * **docs:** replace broken relative link with inline code reference ([#465](#465)) ([8133b36](8133b36)) * **instructions:** prevent local-only paths from leaking into GitHub issues ([#489](#489)) ([497d2fe](497d2fe)) * **workflows:** prevent release-please infinite loop on main branch ([#470](#470)) ([134bdd6](134bdd6)) * **workflows:** remove release-please skip guard that prevents tag creation ([#511](#511)) ([5e53271](5e53271)) ### 📚 Documentation * **agents:** add GitHub Backlog Manager documentation and agent catalog ([#503](#503)) ([5e818ce](5e818ce)) * align CONTRIBUTING.md with docs/contributing/ guides ([#445](#445)) ([73ef6aa](73ef6aa)) ### ♻️ Refactoring * **scripts:** refactor dev-tools and lib scripts to use CIHelpers module ([#482](#482)) ([fdf9145](fdf9145)) * **scripts:** standardize PowerShell entry point guard pattern ([#477](#477)) ([6b84a8e](6b84a8e)) ### 🔧 Maintenance * **config:** standardize action mappings in artifact-retention.yml ([#487](#487)) ([7927db2](7927db2)) * **deps-dev:** bump cspell from 9.6.2 to 9.6.4 in the npm-dependencies group ([#461](#461)) ([c788095](c788095)) * **deps:** bump actions/setup-python from 5.1.1 to 6.2.0 in the github-actions group ([#462](#462)) ([69ef3c9](69ef3c9)) * **security:** add SBOM artifact retention policy ([#479](#479)) ([8031557](8031557)), closes [#453](#453) --- 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>
This was referenced Feb 13, 2026
This was referenced Feb 14, 2026
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.
CONTRIBUTING.md and docs/contributing/ served complementary audiences (general contributors vs AI artifact authors) with only one forward link between them, fragmenting contributor navigation depending on entry point.
Changes
CONTRIBUTING.md
Added AI Artifact Contributions section (before Style Guides):
Updated Improving The Documentation: Added reference to AI artifact guides
Expanded validation commands: Added 6 missing npm scripts (lint:frontmatter, lint:ps, lint:yaml, lint:md-links, lint:all, test:ps) with delegation note to docs/contributing/ai-artifacts-common.md
Reconciled release process: Converted version determination to table format, added delegation link to docs/contributing/release-process.md for complete documentation
docs/contributing/README.md
Added Finding the Right Guide navigation table: Maps 11 contributor intents to starting points covering general contributions (bugs, code, docs) and all AI artifact types
Metadata
Updated ms.date fields to 2026-02-06
Original prompt
This section details on the original issue you should resolve
<issue_title>docs(contributing): align CONTRIBUTING.md with docs/contributing/ guides</issue_title>
<issue_description>## Summary
The root
CONTRIBUTING.mdand thedocs/contributing/folder serve complementary but disconnected audiences.CONTRIBUTING.mdtargets general contributors (bug reporters, code submitters, documentation editors) whiledocs/contributing/targets AI artifact authors (agents, prompts, instructions, skills) and provides repo operations references (branch protection, release process, copyright headers, roadmap). Neither ecosystem adequately cross-references the other, creating a fragmented contributor experience where newcomers miss relevant guidance depending on which entry point they discover first.This issue tracks the work to map, reconcile, and cross-link these two contributing documentation surfaces so that every contributor — regardless of entry point — can navigate the full contribution landscape.
Content Mapping Analysis
Current Structure
CONTRIBUTING.mddocs/contributing/README.mddocs/contributing/*.md(9 files)Cross-Reference Inventory
docs/contributing/README.md../../CONTRIBUTING.mdCONTRIBUTING.mddocs/contributing/copyright-headers.mdCONTRIBUTING.md.github/instructions/commit-message.instructions.mdOne forward link from
CONTRIBUTING.mdintodocs/contributing/is the only bridge between these two documentation surfaces.Identified Gaps
1. Missing Cross-References from CONTRIBUTING.md
CONTRIBUTING.mdhas an "Improving The Documentation" section that says to "follow the your first code contribution guidance" but never points contributors to the extensive specialized guides indocs/contributing/for:custom-agents.md)instructions.md)prompts.md)skills.md)ai-artifacts-common.md)A contributor wanting to improve documentation — the most common external contribution type — has no path from
CONTRIBUTING.mdto these guides.2. No Unified Contributor Navigation
There is no documentation that presents the complete contributor journey spanning both surfaces. A first-time contributor who lands on
CONTRIBUTING.mddiscovers bug reporting, enhancement suggestions, code contribution, and basic documentation guidance — but never learns about the AI artifact ecosystem. Conversely, a contributor who lands ondocs/contributing/README.mdgets linked back toCONTRIBUTING.mdfor "general contribution guidelines" but may not realize that release process details, testing requirements, and coding conventions live there.3. Content Overlap Without Reconciliation
Three topics appear in both surfaces with different levels of detail and no reconciliation:
release-process.md: comprehensive — extension publishing, channels, maturity lifecycle, version calculation table, mermaid diagramsnpm run lint:md,spell-check,format:tablesai-artifacts-common.md:lint:frontmatter,lint:md,spell-check,lint:md-links,lint:pscopyright-headers.mdcopyright-headers.md: SPDX format, placement rules, PSScriptAnalyzer integration4. Missing General Contribution Guidance in docs/contributing/
docs/contributing/has no coverage of:These only exist in
CONTRIBUTING.md, leavingdocs/contributing/incomplete as a standalone reference.5. Stale Content in CONTRIBUTING.md
CONTRIBUTING.mdis dated 2025-11-05, while severaldocs/contributing/files are significantly newer:CONTRIBUTING.mdskills.md...💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.