microsoft/hve-core

Public

mirrored from https://github.com/microsoft/hve-coreAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
main

Branches

Tags

  • No tags available.
294Branches29Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

Commit

fix(docs): add missing Copilot footers, consolidate validation exclusions (#419)

## Description

This PR addresses markdown footer compliance warnings by adding the
standard Copilot footer to 8 documentation files and consolidating
exclusion path definitions into `Validate-MarkdownFrontmatter.ps1` as
parameter defaults. This establishes a single source of truth for
validation exclusions, simplifying both the GitHub workflow and npm
script invocations.

- Added standard Copilot footer to `GOVERNANCE.md`, `docs/README.md`,
`docs/architecture/README.md`, `docs/architecture/ai-artifacts.md`,
`docs/architecture/testing.md`, `docs/architecture/workflows.md`,
`docs/contributing/ROADMAP.md`, and
`docs/templates/security-plan-template.md`
- Consolidated `ExcludePaths` default in script:
`scripts/tests/Fixtures/**`, `extension/README.md`, `pr.md`,
`.github/PULL_REQUEST_TEMPLATE.md`
- Consolidated `FooterExcludePaths` default in script: `CHANGELOG.md`,
`dependency-pinning-artifacts/**`
- Simplified `frontmatter-validation.yml` workflow by removing hardcoded
ExcludePaths
- Simplified `package.json` lint:frontmatter script to use script
defaults
- Fixed `docs/architecture/workflows.md` ms.topic from `architecture` to
`overview`

## Related Issue(s)

Closes #415

## Type of Change

Select all that apply:

**Code & Documentation:**

- [x] 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)
- [x] Documentation update

**Infrastructure & Configuration:**

- [x] 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`)

**Other:**

- [x] Script/automation (`.ps1`, `.sh`, `.py`)
- [ ] Other (please describe):

## Testing

- Ran `npm run lint:frontmatter` - 116 files validated, 0 errors, 0
warnings
- Ran `npm run test:ps` - 850 tests passed, 0 failed
- Ran `npm run lint:md` - 120 files validated, no errors
- Ran `npm run spell-check` - 89 files validated, no issues

## Checklist

### Required Checks

- [x] Documentation is updated (if applicable)
- [x] Files follow existing naming conventions
- [x] Changes are backwards compatible (if applicable)
- [ ] Tests added for new functionality (if applicable)

### Required Automated Checks

The following validation commands must pass before merging:

- [x] Markdown linting: `npm run lint:md`
- [x] Spell checking: `npm run spell-check`
- [x] Frontmatter validation: `npm run lint:frontmatter`
- [ ] Link validation: `npm run lint:md-links`
- [x] PowerShell analysis: `npm run lint:ps`

## Security Considerations

- [x] This PR does not contain any sensitive or NDA information
- [ ] Any new dependencies have been reviewed for security issues
- [x] Security-related scripts follow the principle of least privilege

## Additional Notes

The exclusion path consolidation establishes
`Validate-MarkdownFrontmatter.ps1` as the single source of truth for
validation exclusions. Callers (workflow and npm script) no longer need
to specify exclusions unless overriding the defaults.

📝 - Generated by Copilot
Changed files1010 shown on this page
Branches0Containing branches
Tags0Containing tags