-
Notifications
You must be signed in to change notification settings - Fork 0
Add formatting guide and fix script path references #121
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # Code Formatting | ||
|
|
||
| This repository uses `dotnet format` to enforce consistent C# code style. | ||
|
|
||
|
Chris-Wolfgang marked this conversation as resolved.
|
||
| ## Prerequisites | ||
|
|
||
| The `dotnet format` command is **built into the .NET SDK** starting with .NET 6 and later. Since this project requires .NET 8.0 SDK or later, you already have `dotnet format` available — no separate tool installation is needed. | ||
|
|
||
| > **Note:** The standalone `dotnet-format` global tool was deprecated when `dotnet format` was integrated into the .NET 6 SDK in August 2021. | ||
|
|
||
| ## For Developers | ||
|
|
||
| ### Before Committing | ||
|
|
||
| Run the formatting script with PowerShell Core (`pwsh`) on any supported platform: | ||
|
|
||
| ```powershell | ||
| pwsh ./scripts/format.ps1 | ||
| ``` | ||
|
|
||
| Or check without making changes: | ||
|
|
||
| ```powershell | ||
| pwsh ./scripts/format.ps1 -Check | ||
| ``` | ||
|
Chris-Wolfgang marked this conversation as resolved.
Chris-Wolfgang marked this conversation as resolved.
|
||
|
|
||
| ### Manual Formatting | ||
|
|
||
| ```bash | ||
| dotnet format | ||
| ``` | ||
|
|
||
| ### Check Formatting (like CI does) | ||
|
|
||
| ```bash | ||
| dotnet format --verify-no-changes | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| Code style rules are defined in `.editorconfig` at the repository root. | ||
|
|
||
| ## CI/CD | ||
|
|
||
| All pull requests are automatically checked for proper formatting. PRs with formatting issues will fail the build. | ||
|
|
||
| ### If CI Fails | ||
|
|
||
| 1. Run `pwsh ./scripts/format.ps1` locally | ||
| 2. Review the changes | ||
| 3. Commit and push the formatted code | ||
|
|
||
| ## IDE Integration | ||
|
|
||
| Most IDEs automatically read `.editorconfig`: | ||
|
|
||
| - **Visual Studio**: Built-in support, formats on save (Tools → Options → Text Editor → C# → Code Style) | ||
| - **VS Code**: Install "EditorConfig for VS Code" extension | ||
| - **JetBrains Rider**: Built-in support | ||
|
|
||
| ## Formatting Rules | ||
|
|
||
| Key style rules: | ||
| - **Indentation**: 4 spaces for C# (with `switch` case contents not additionally indented when inside a block, per `.editorconfig`), 2 for XML/JSON | ||
| - **Braces**: Opening brace on new line | ||
| - **Line endings**: LF (Unix style) for most files; PowerShell scripts (`*.ps1`) use CRLF as configured in `.editorconfig` | ||
| - **Trailing whitespace**: Removed | ||
| - **Using directives**: System namespaces first, sorted alphabetically | ||
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.