Add formatting guide and fix script path references#121
Merged
Conversation
The formatting script is at scripts/format.ps1, not the repo root. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates formatting documentation to reference the scripts/format.ps1 helper script, aligning formatting instructions with the repository’s script layout.
Changes:
- Updates documented invocation paths to
.\scripts\format.ps1(and-Checkvariant). - Adds/updates formatting guidance around
dotnet format, CI verification, and key.editorconfigrules.
Chris-Wolfgang
changed the title
- Use cross-platform pwsh ./scripts/format.ps1 syntax in docs and script help - Fix broken links in README.md and CONTRIBUTING.md to point to docs/README-FORMATTING.md - Document CRLF exception for PowerShell scripts in line endings section Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.
Summary
docs/README-FORMATTING.mdwith formatting prerequisites, commands, and style rule summaryREADME.mdandCONTRIBUTING.mdlinks to point todocs/README-FORMATTING.mdpwsh ./scripts/format.ps1syntax in all documentationTest plan
docs/README-FORMATTING.md🤖 Generated with Claude Code