Skip to content

Add missing Copilot footers, consolidate validation exclusions, fix topic type #415

@WilliamBerryiii

Description

@WilliamBerryiii

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.ps1 param defaults (empty arrays)
  • .github/workflows/frontmatter-validation.yml (hardcoded + input default)
  • package.json lint: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.md ms.topic from 'architecture' to 'overview'

Acceptance Criteria

  1. All listed files have the standard Copilot footer
  2. Exclusion paths consolidated into script defaults
  3. package.json and workflow simplified to rely on defaults
  4. Local and CI validation produce identical results
  5. npm run lint:frontmatter passes 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

Metadata

Metadata

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions