Skip to content

docs: align PR template model version note with providerAllowlist policy - #2557

Open
tasdevani21 wants to merge 2 commits into
microsoft:mainfrom
tasdevani21:docs/2026-pr-template-model-catalog-reference
Open

docs: align PR template model version note with providerAllowlist policy#2557
tasdevani21 wants to merge 2 commits into
microsoft:mainfrom
tasdevani21:docs/2026-pr-template-model-catalog-reference

Conversation

@tasdevani21

Copy link
Copy Markdown
Contributor

Pull Request

Description

The PR template at .github/PULL_REQUEST_TEMPLATE.md (line 42) contained a hardcoded note stating that only Anthropic and OpenAI models are accepted. This is no longer accurate: PR #2014 added Google and Microsoft to the providerAllowlist in scripts/linting/model-catalog.json, and the contributing/customization docs (docs/contributing/custom-agents.md, docs/contributing/ai-artifacts-common.md, docs/customization/custom-agents.md) already treat the catalog as the source of truth.

This PR replaces the hardcoded note with the same catalog-based wording used in docs/contributing/ai-artifacts-common.md#model-version-requirements, which the very next line of the template already links to. The result is a single consistent policy statement across the template and the contributing docs.

Related Issue(s)

Fixes #2026

Type of Change

Code & Documentation:

  • Documentation update

Testing

Cross-checked the new wording against docs/contributing/ai-artifacts-common.md (line 88, 92) and docs/contributing/custom-agents.md (line 96) to confirm the phrasing, backticked-path convention (no markdown link, matching all four sibling references), and RFC 2119 MUST style are consistent with the codebase. Verified providerAllowlist and the ga/preview status values in scripts/linting/model-catalog.json match the new wording. Only .github/PULL_REQUEST_TEMPLATE.md is modified.

Checklist

Required Checks

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

Required Local Checks

  • 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

Scope is intentionally minimal: a single line replacement, no other edits to the template or repository.

Replace the hardcoded 'Anthropic and OpenAI only' note in the PR template
with the model-catalog reference wording used across the contributing and
customization docs. This reflects the actual providerAllowlist policy
(Anthropic, Google, OpenAI, Microsoft) established in PR microsoft#2014 and aligns
the template with the Model Version Requirements section it already links
to on the next line.

Fixes microsoft#2026

📝
@tasdevani21
tasdevani21 requested a review from a team as a code owner July 29, 2026 18:17
@codecov-commenter

codecov-commenter commented Jul 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.69%. Comparing base (cf29fb4) to head (1588e8c).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2557      +/-   ##
==========================================
- Coverage   82.75%   82.69%   -0.06%     
==========================================
  Files         155      143      -12     
  Lines       20960    20870      -90     
  Branches       13        0      -13     
==========================================
- Hits        17345    17259      -86     
+ Misses       3613     3611       -2     
+ Partials        2        0       -2     
Flag Coverage Δ
docusaurus ?
pester 86.18% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 13 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.

docs: update PULL_REQUEST_TEMPLATE.md model version note to reference providerAllowlist

3 participants