Clarify CSharpier should be run from project root

Co-authored-by: adamhathcock <527620+adamhathcock@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-10-27 11:07:02 +00:00
parent 48be7bbf86
commit b272dbfd1f

View File

@@ -31,8 +31,8 @@ SharpCompress is a pure C# compression library supporting multiple archive forma
- Use CSharpier for code formatting to ensure consistent style across the project
- CSharpier is configured as a local tool in `.config/dotnet-tools.json`
- Restore tools with: `dotnet tool restore`
- Format files with: `dotnet csharpier .`
- **Run `dotnet csharpier .` after making code changes before committing**
- Format files from the project root with: `dotnet csharpier .`
- **Run `dotnet csharpier .` from the project root after making code changes before committing**
- Configure your IDE to format on save using CSharpier for the best experience
- The project also uses `.editorconfig` for editor settings (indentation, encoding, etc.)
- Let CSharpier handle code style while `.editorconfig` handles editor behavior