-
Notifications
You must be signed in to change notification settings - Fork 125
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Summary
Multiple documentation files are missing the standard Copilot attribution footer. Additionally, exclusion paths are duplicated across package.json, workflow YAML, and script invocations—creating maintenance burden and local/CI divergence.
Files Requiring Footer
- docs/README.md
- docs/architecture/README.md
- docs/architecture/testing.md
- docs/architecture/ai-artifacts.md (replace alternate footer)
- docs/architecture/workflows.md (replace alternate footer)
- docs/contributing/ROADMAP.md
- docs/templates/security-plan-template.md
- GOVERNANCE.md
-
.github/PULL_REQUEST_TEMPLATE.md(now excluded from validation)
Exclusion Path Consolidation
Problem: Exclusion paths are maintained in three places with inconsistent values:
Validate-MarkdownFrontmatter.ps1param defaults (empty arrays).github/workflows/frontmatter-validation.yml(hardcoded + input default)package.jsonlint:frontmatter script
Solution: Consolidate all defaults into Validate-MarkdownFrontmatter.ps1:
[string[]]$ExcludePaths = @(
'scripts/tests/Fixtures/**',
'extension/README.md'
),
[string[]]$FooterExcludePaths = @(
'CHANGELOG.md',
'pr.md',
'dependency-pinning-artifacts/**',
'.github/PULL_REQUEST_TEMPLATE.md'
)Then simplify callers to not pass explicit values.
Additional Fixes
- Fix
docs/architecture/workflows.mdms.topic from 'architecture' to 'overview'
Acceptance Criteria
- All listed files have the standard Copilot footer
- Exclusion paths consolidated into script defaults
- package.json and workflow simplified to rely on defaults
- Local and CI validation produce identical results
npm run lint:frontmatterpasses with--warnings-as-errors
Standard Footer Format
🤖 *Crafted with precision by ✨Copilot following brilliant human instruction, then carefully refined by our team of discerning human reviewers.*Research
Implementation Plan
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request