Skip to content

docs(ai-artifacts): align contribution guide with plugin and collection workflow#622

Merged
katriendg merged 2 commits intomainfrom
docs/621-ai-artifacts
Feb 16, 2026
Merged

docs(ai-artifacts): align contribution guide with plugin and collection workflow#622
katriendg merged 2 commits intomainfrom
docs/621-ai-artifacts

Conversation

@katriendg
Copy link
Copy Markdown
Contributor

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-existent requires field in collection manifests

  • docs(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/ exclusion

  • docs(ai-artifacts): added npm run plugin:validate and npm run plugin:generate steps to the contribution workflow, with enumerated validation checks covering YAML syntax, required fields, path references, kind/maturity values, duplicate detection, and hve-core exclusions

Related Issue(s)

Closes #621

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:

  • GitHub Actions workflow
  • Linting configuration (markdown, PowerShell, etc.)
  • Security configuration
  • DevContainer configuration
  • Dependency update

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)
  • Copilot skill (.github/skills/*/SKILL.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.
  • Skills: Must include both bash and PowerShell scripts. See Skills.
  • 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):

Testing

Validated documentation changes against the actual scripts and collection files referenced in the guide. Confirmed accuracy of npm run plugin:validate and npm run plugin:generate command documentation against scripts/plugins/Validate-Collections.ps1 and scripts/plugins/Generate-Plugins.ps1.

Checklist

Required Checks

  • Documentation is updated (if applicable)
  • Files follow existing naming conventions
  • Changes are backwards compatible (if applicable)
  • Tests added for new functionality (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 PR addresses documentation drift where the contribution guide described a requires dependency field on collection manifest items that does not exist in production. The corrected documentation now accurately reflects that dependencies are resolved through agent frontmatter handoffs declarations during extension packaging, not through collection manifest fields.

📝 - Generated by Copilot

…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
@katriendg katriendg requested a review from a team as a code owner February 16, 2026 09:22
Copilot AI review requested due to automatic review settings February 16, 2026 09:22
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Feb 16, 2026

Dependency Review

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

Scanned Files

None

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Feb 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.34%. Comparing base (5bcea1d) to head (78d6c7a).

Additional details and impacted files

Impacted file tree graph

@@            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     
Flag Coverage Δ
pester 85.34% <ø> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@katriendg katriendg merged commit 21820be into main Feb 16, 2026
18 checks passed
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(ai-artifacts): align artifact docs with plugin and collection workflow

4 participants