Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (20 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 1.45 KB

Contributing to ArcNET

Thank you for considering contributing!

How to Contribute

  1. Fork the repository and create a feature branch from main.
  2. Run dotnet tool restore to install local tools (CSharpier).
  3. Ensure your code passes all checks: 
    dotnet build -c Release
dotnet test
dotnet csharpier check .
dotnet format style --verify-no-changes
dotnet format analyzers --verify-no-changes
  4. Open a Pull Request against main with a clear description of the change.

Code Style

This project enforces formatting via CSharpier (opinionated C# formatter) and dotnet format (code style analyzers). CI will reject PRs with formatting violations.

  • Auto-format before committing: dotnet csharpier format . first (fixes whitespace/brace style), then dotnet format style && dotnet format analyzers (fixes naming/usings). Order matters: always run CSharpier first. Never run bare dotnet format — the whitespace sub-check overwrites CSharpier's Allman-style brace formatting.
  • IDE integration: Install the CSharpier extension for VS Code, Visual Studio, or Rider for format-on-save.

Reporting Issues

Use GitHub Issues for bugs and feature requests.