Skip to content

Improve whitespace guidance and tooling#767

Open
johnml1135 wants to merge 1 commit intomainfrom
improve-whitespace-guidance
Open

Improve whitespace guidance and tooling#767
johnml1135 wants to merge 1 commit intomainfrom
improve-whitespace-guidance

Conversation

@johnml1135
Copy link
Contributor

@johnml1135 johnml1135 commented Mar 17, 2026

Summary

  • document the required local CI parity tasks for whitespace and commit-message checks
  • clarify that whitespace validation is commit-history based
  • preserve UTF-8 BOM behavior in the local whitespace fixer so it does not introduce spurious diffs

Validation

  • CI: Full local check

This change is Reviewable

Copilot AI review requested due to automatic review settings March 17, 2026 00:33
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documents and aligns local developer/agent guidance with CI whitespace and commit-message checks, and updates the local whitespace fixer to preserve UTF-8 BOM to avoid unnecessary diffs.

Changes:

  • Preserve UTF-8 BOM when rewriting files in fix-whitespace.ps1.
  • Clarify that whitespace validation is based on commit history (origin/main..HEAD) in check-whitespace.ps1.
  • Update repository/agent instructions to prefer VS Code “CI:*” tasks for local CI parity.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
Build/Agent/fix-whitespace.ps1 Detect and preserve UTF-8 BOM when re-writing files; improve user guidance output.
Build/Agent/check-whitespace.ps1 Clarify commit-range semantics and remediation steps in whitespace failure output.
AGENTS.md Add CI parity task guidance and update the validation checklist.
.github/instructions/terminal.instructions.md Prefer CI parity VS Code tasks over ad-hoc shell commands.
.github/instructions/repo.instructions.md Add succinct CI parity rules for whitespace and commit-message checks.

Comment on lines +34 to 35
$hasUtf8Bom = Test-HasUtf8Bom -Path $Path
try {
Comment on lines +16 to +17
$bytes = [System.IO.File]::ReadAllBytes($Path)
return $bytes.Length -ge 3 -and $bytes[0] -eq 0xEF -and $bytes[1] -eq 0xBB -and $bytes[2] -eq 0xBF
@github-actions
Copy link

NUnit Tests

    1 files  ±0      1 suites  ±0   5m 50s ⏱️ +6s
4 058 tests ±0  3 987 ✅ ±0  71 💤 ±0  0 ❌ ±0 
4 067 runs  ±0  3 996 ✅ ±0  71 💤 ±0  0 ❌ ±0 

Results for commit fc536e0. ± Comparison against base commit d58727c.

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.

2 participants