Skip to content

docs: clarify marketplace registration behavior - #2799

Open
Dhruva Kumar (dhruvatr) wants to merge 2 commits into
microsoft:mainfrom
dhruvatr:patch-1
Open

docs: clarify marketplace registration behavior#2799
Dhruva Kumar (dhruvatr) wants to merge 2 commits into
microsoft:mainfrom
dhruvatr:patch-1

Conversation

@dhruvatr

Copy link
Copy Markdown

Pull Request

Description

Related Issue(s)

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 hve-builder and addressed all actionable findings
  • Copilot instructions (.github/instructions/*.instructions.md)
  • Copilot prompt (.github/prompts/*.prompt.md)
  • Copilot agent (.github/agents/*.agent.md)
  • Copilot skill (.github/skills/*/SKILL.md)
  • Copilot hook (.github/hooks/*/*.json)
  • Eval spec added/updated for changed AI artifacts (evals/)

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: Contributions MUST target models listed in the model catalog (scripts/linting/model-catalog.json) whose provider appears in providerAllowlist and whose status is ga or preview. Run npm run lint:models to validate references.
  • See Agents Not Accepted and Model Version Requirements.

Other:

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

Sample Prompts (for AI Artifact Contributions)

User Request:

Execution Flow:

Output Artifacts:

Success Indicators:

For detailed contribution requirements, see:

Testing

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 hve-builder review mode to review contribution
  • Addressed all actionable findings from the hve-builder review
  • Verified contribution follows common standards and type-specific requirements

Required Local Checks

The following local-safe validation commands must pass before merging:

  • Local validation aggregate: npm run validate:local
  • Documentation validation (if docs changed): npm run validate:docs
  • Spell checking: npm run spell-check
  • Link validation: npm run lint:md-links

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

Description

Improved the grammar and clarity of the sentence describing marketplace registration behavior in the HVE Core documentation.

Changes made

  • Added "The" at the beginning of the sentence for grammatical correctness.
  • Added "yet" to make the wording clearer.

This is a documentation-only change and does not affect functionality.

@dhruvatr
Dhruva Kumar (dhruvatr) requested a review from a team as a code owner August 29, 2026 16:52

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for improving the marketplace note. The comprehensive review found five items:

  1. Complete the PR description with the purpose, scope, and validation performed.
  2. Select the Documentation update change type.
  3. Resolve the currently blocked merge requirement before merging.
  4. Distinguish the known switching guidance from version-dependent duplicate-registration behavior (inline comment).
  5. Restore the explicit blockquote marker on the wrapped line (inline comment).

The change is documentation-only and has no functional, security, or accessibility regression. The recommended disposition is approve with comments after these documentation and readiness items are addressed.

Comment thread README.md
Comment on lines +69 to 71
> The behavior when switching or duplicating same-name marketplace registrations
has not yet been observed. See [CLI Plugins](docs/getting-started/methods/cli-plugins.md)
> for details.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Medium — distinguish switching guidance from duplicate-registration uncertainty

This sentence groups switching and duplicate registration together as wholly unobserved. The linked guide is more specific: switching can require removing and re-adding the marketplace, while duplicate same-name handling can vary by CLI version. Please preserve that distinction here so readers do not miss the actionable switching guidance.

Suggested wording:

Suggested change
> The behavior when switching or duplicating same-name marketplace registrations
has not yet been observed. See [CLI Plugins](docs/getting-started/methods/cli-plugins.md)
> for details.
> Switching registrations can require removing and re-adding the marketplace.
> Duplicate same-name registration behavior can vary by Copilot CLI version. See
> [CLI Plugins](docs/getting-started/methods/cli-plugins.md) for details.

Comment thread README.md
> Behavior when switching or duplicating same-name marketplace registrations
> has not been observed. See [CLI Plugins](docs/getting-started/methods/cli-plugins.md)
> The behavior when switching or duplicating same-name marketplace registrations
has not yet been observed. See [CLI Plugins](docs/getting-started/methods/cli-plugins.md)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Low — preserve the explicit blockquote marker

This wrapped line relies on lazy blockquote continuation, unlike the surrounding lines. Please retain the explicit marker for consistent source structure and renderer-independent behavior.

Suggested change
has not yet been observed. See [CLI Plugins](docs/getting-started/methods/cli-plugins.md)
> has not yet been observed. See [CLI Plugins](docs/getting-started/methods/cli-plugins.md)

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.09%. Comparing base (90414cb) to head (74717e1).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##             main    #2799    +/-   ##
========================================
  Coverage   83.08%   83.09%            
========================================
  Files         183      171    -12     
  Lines       33712    33994   +282     
  Branches       25        0    -25     
========================================
+ Hits        28010    28246   +236     
- Misses       5699     5748    +49     
+ Partials        3        0     -3     
Flag Coverage Δ
docusaurus ?
pester 83.90% <ø> (+0.08%) ⬆️

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.

4 participants