Skip to content

Enable C# nullable reference types and TreatWarningsAsErrors across the solution #192

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.

Sign up for GitHub

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

Draft
Copilot wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Enable C# nullable reference types and TreatWarningsAsErrors across the solution #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9c585fe
Initial plan
Copilot Oct 17, 2025
dfdafd1
Add Directory.Build.props with Nullable and TreatWarningsAsErrors
Copilot Oct 17, 2025
554fbb2
Document code quality settings in README
Copilot Oct 17, 2025
880edcb
Add build step to CI workflow to enforce TreatWarningsAsErrors
Copilot Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/dotnet.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,6 @@ jobs:
dotnet-version: '10.0.100-rc.1.25451.107'
# You can test your matrix by printing the current dotnet version
- name: Display dotnet version
run: dotnet --version
run: dotnet --version
- name: Build solution
run: dotnet build Visage.sln --configuration Release
9 changes: 9 additions & 0 deletions Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<Project>
<PropertyGroup>
<!-- Enable nullable reference types for better null-safety -->
<Nullable>enable</Nullable>

<!-- Treat all warnings as errors to catch issues during development -->
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
</PropertyGroup>
</Project>
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,26 @@ For more detailed instructions and examples, refer to the test project files in

By following these guidelines, we can ensure that our codebase remains reliable, maintainable, and of high quality.

## Code Quality and Build Configuration

The Visage project enforces strict code quality standards through MSBuild configuration:

### Nullable Reference Types

All projects have nullable reference types enabled via `Directory.Build.props`, which provides:
- Static analysis for potential null reference issues
- Explicit handling of nullable types
- Improved null safety throughout the codebase

### TreatWarningsAsErrors

The solution is configured to treat all compiler warnings as errors (`TreatWarningsAsErrors=true`). This ensures:
- Code won't compile until warnings are addressed
- Issues are caught during development rather than production
- Consistent code quality across all projects

These settings are centrally managed in the `Directory.Build.props` file located at the solution root, ensuring they apply to all projects in the solution automatically.

## Project Architecture and Components

The Visage project is built using a modular architecture to ensure scalability, maintainability, and ease of development. Below is an overview of the project's architecture and its main components:
Expand Down