fix(docs): quote YAML frontmatter values in BRD template#339
Merged
WilliamBerryiii merged 1 commit intomainfrom Jan 28, 2026
Merged
fix(docs): quote YAML frontmatter values in BRD template#339WilliamBerryiii merged 1 commit intomainfrom
WilliamBerryiii merged 1 commit intomainfrom
Conversation
- quote title, description, and author fields containing special characters - resolve 'Block sequence entries are not allowed' YAML parse error - update ms.date to 2026-01-28 - add standard Copilot footer 📝 - Generated by Copilot
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #339 +/- ##
==========================================
- Coverage 41.08% 41.04% -0.04%
==========================================
Files 15 15
Lines 2870 2870
==========================================
- Hits 1179 1178 -1
- Misses 1691 1692 +1
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a YAML syntax error in the BRD template that was causing frontmatter validation to fail. The fix adds proper quoting to template variables containing special characters and brings the template in line with established codebase conventions.
Changes:
- Added double quotes around YAML frontmatter values containing template variables and hyphens to prevent YAML parser errors
- Updated the
ms.datefield from a past date (2025-12-05) to the current date (2026-01-28) - Added the standard Copilot attribution footer with markdownlint control comments
nguyena2
approved these changes
Jan 28, 2026
WilliamBerryiii
pushed a commit
that referenced
this pull request
Jan 28, 2026
🤖 I have created a release *beep* *boop* --- ## [2.0.1](hve-core-v2.0.0...hve-core-v2.0.1) (2026-01-28) ### 🐛 Bug Fixes * **build:** use draft releases for VSIX upload ([#338](#338)) ([f1d3ac6](f1d3ac6)) * **docs:** quote YAML frontmatter values in BRD template ([#339](#339)) ([ca988f2](ca988f2)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: hve-core-release-please[bot] <254602402+hve-core-release-please[bot]@users.noreply.github.com>
This was referenced Jan 28, 2026
This was referenced Feb 6, 2026
This was referenced Feb 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixed a YAML syntax error in
docs/templates/brd-template.mdthat causednpm run lint:frontmatterto fail. The frontmatter values containing-(space-hyphen-space) and template variables{{...}}were interpreted as YAML block sequence indicators, triggering a "Block sequence entries are not allowed" parse error.title,description, andauthorfrontmatter fields with double quotes to prevent YAML special character interpretationms.datefrom2025-12-05to2026-01-28Related Issue(s)
Closes #331
Type of Change
Select all that apply:
Code & Documentation:
Infrastructure & Configuration:
AI Artifacts:
prompt-builderagent and addressed all feedback.github/instructions/*.instructions.md).github/prompts/*.prompt.md).github/agents/*.agent.md)Other:
.ps1,.sh,.py)Testing
npm run lint:frontmatter -- -Files "docs/templates/brd-template.md"→ 0 errors, 0 warningsnpm run lint:md→ 0 errors across 117 filesChecklist
Required Checks
AI Artifact Contributions
N/A - Not an AI artifact contribution
Required Automated Checks
The following validation commands must pass before merging:
npm run lint:mdnpm run spell-checknpm run lint:frontmatternpm run lint:md-linksnpm run lint:psSecurity Considerations
Additional Notes
This fix follows the documented quoting pattern from prompts.md which shows double-quoted template variables as the correct style for YAML frontmatter.
📝 - Generated by Copilot