Pull Request Guidelines¶
To maintain high code quality and consistency, every developer must complete these steps before requesting a code review. Our Continuous Integration (CI) pipeline will automatically reject any PR that fails these checks.
Backend Requirements¶
Before submission, you must ensure the codebase adheres to our formatting and quality standards. Follow the steps below in order.
Code Formatting¶
We use CSharpier and the dotnet format tool to uphold our standards. Run these commands in your terminal:
dotnet tool restore
dotnet csharpier format backend/
dotnet format style backend/GameBackend.sln --no-restore --severity error --verbosity normal
dotnet format analyzers backend/GameBackend.sln --no-restore --severity error --verbosity normal
Testing & Coverage¶
Code quality isn't just about how it looks; it's about how it performs.
Coverage Threshold
The code coverage for the backend/src/ directory must be 70% or higher.
Automated Checks¶
CI/CD Pipeline
Our pipeline automatically runs a check against the rules listed above. If any step fails: The PR will be rejected automatically. Feedback will be provided in the CI logs indicating which specific step failed. You must fix the issues and push the changes before the review can proceed.