docs(ai-artifacts): align contribution guide with plugin and collection workflow#622
Merged
docs(ai-artifacts): align contribution guide with plugin and collection workflow#622
Conversation
…racy - restructure collections section with improved flow (collections → extension → plugins) - add comprehensive plugin generation documentation with validation workflow - correct dependency resolution documentation (remove non-existent requires field) - expand repo-specific exclusion guidance with validation enforcement details - add steps for plugin validation and regeneration to contribution workflow
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #622 +/- ##
==========================================
- Coverage 85.36% 85.34% -0.03%
==========================================
Files 23 23
Lines 4475 4475
==========================================
- Hits 3820 3819 -1
- Misses 655 656 +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
This PR comprehensively updates the AI Artifacts Common contribution guide to accurately document the production plugin and collection system. The restructured documentation corrects outdated information about dependency declarations, adds detailed plugin generation guidance, and expands repo-specific exclusion enforcement details.
Changes:
- Restructured the Collections section for improved learning flow, renaming and reordering subsections to follow a logical progression from collections through extension packaging to plugin generation
- Added comprehensive Plugin Generation section documenting the contributor workflow including validation, generation commands, directory structure, and critical warnings against direct edits
- Replaced the incorrect Dependency Declarations section with accurate Extension Packaging documentation describing agent handoff dependency resolution via BFS traversal
WilliamBerryiii
approved these changes
Feb 16, 2026
WilliamBerryiii
pushed a commit
that referenced
this pull request
Feb 17, 2026
🤖 I have created a release *beep* *boop* --- ## [2.3.10](hve-core-v2.3.9...hve-core-v2.3.10) (2026-02-17) ### 🐛 Bug Fixes * **agents:** add subagent support with dedicated subagent files and simplified prompts ([#639](#639)) ([c080b0a](c080b0a)) * Markdown table in Codespace is not rendered correctly ([#619](#619)) ([5bcea1d](5bcea1d)) ### 📚 Documentation * **ai-artifacts:** align contribution guide with plugin and collection workflow ([#622](#622)) ([21820be](21820be)) --- 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 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.
Description
Reorganized the AI Artifacts Common contribution guide to accurately reflect the plugin and collection system currently in production. The restructured documentation corrects outdated dependency declarations, adds comprehensive plugin generation guidance, and expands repo-specific exclusion enforcement details.
docs(ai-artifacts): restructured the Collections section for improved learning flow, renaming "Collection Manifests" to "Collections" and reordering subsections to follow a logical progression from collections through extension packaging to plugin generation
docs(ai-artifacts): added comprehensive Plugin Generation section documenting the full contributor workflow, including generation commands, plugin directory structure, critical rules against direct edits, regeneration triggers, and validation checks
docs(ai-artifacts): replaced the incorrect Dependency Declarations section with Extension Packaging documentation that accurately describes agent handoff dependency resolution via BFS traversal in
Prepare-Extension.ps1, removing references to a non-existentrequiresfield in collection manifestsdocs(ai-artifacts): expanded repo-specific exclusion guidance with validation enforcement details, a placement guidelines table, and explicit documentation of how plugin generation and collection validation actively enforce the
.github/**/hve-core/exclusiondocs(ai-artifacts): added
npm run plugin:validateandnpm run plugin:generatesteps to the contribution workflow, with enumerated validation checks covering YAML syntax, required fields, path references, kind/maturity values, duplicate detection, and hve-core exclusionsRelated Issue(s)
Closes #621
Type of Change
Select all that apply:
Code & Documentation:
Infrastructure & Configuration:
AI Artifacts:
prompt-builderagent and addressed all feedback.github/instructions/*.instructions.md).github/prompts/*.prompt.md).github/agents/*.agent.md).github/skills/*/SKILL.md)Other:
.ps1,.sh,.py)Testing
Validated documentation changes against the actual scripts and collection files referenced in the guide. Confirmed accuracy of
npm run plugin:validateandnpm run plugin:generatecommand documentation againstscripts/plugins/Validate-Collections.ps1andscripts/plugins/Generate-Plugins.ps1.Checklist
Required Checks
AI Artifact Contributions
/prompt-analyzeto review contributionprompt-builderreviewRequired Automated Checks
The following validation commands must pass before merging:
npm run lint:mdnpm run spell-checknpm run lint:frontmatternpm run lint:md-linksnpm run lint:psSecurity Considerations
Additional Notes
This PR addresses documentation drift where the contribution guide described a
requiresdependency field on collection manifest items that does not exist in production. The corrected documentation now accurately reflects that dependencies are resolved through agent frontmatterhandoffsdeclarations during extension packaging, not through collection manifest fields.📝 - Generated by Copilot