CONTRIBUTING.md

Developer's guide

Local steps

1. Install .NET 10.0 SDK

   # makes sure .NET is installed and displays the version
   dotnet --version

2. Build and test from the command line

   # builds the solution
   dotnet build
   
   # runs the tests
   dotnet test
   
   # runs one specific test project (here Configuration.UnitTests) 
   dotnet test --project test\Configuration.UnitTests
   
   # creates the packages
   dotnet pack

3. Develop in an IDE (Rider - recommended, Visual Studio 2026 or Visual Studio Code)

   From the IDE, you can build the solution, run and debug the tests.

4. Quality checks

   # review .NET code against .editorconfig
   dotnet format
   
   # lints YAML files
   docker run --rm -v "$(pwd)":/data cytopia/yamllint .
   
   # lints Markdown files
   docker run --rm -v "$(pwd)":/workdir davidanson/markdownlint-cli2 "**/*.md"
   
   # ensures EOL is correct
   find . -type f \( -name "*.cs" -o -name "*.csproj" -o -name "*.slnx" -o -name "*.js" -o -name "*.razor" -o -name "*.css" \) -exec sed -i 's/\r$//' {} +
   
   # ensures container build is successful
   docker build . -t withywoods-demoblazorwebapp:local -f samples/DemoBlazorWebApp/Dockerfile
   docker build . -t withywoods-demoblazorwebapp:local -f samples/DemoWebApi/Dockerfile

5. Demo containers images

   • Start containers

     docker compose up

   • Open the web app in a browser: DemoBlazorWebApp, DemoWebApi

   • Clean-up

     docker compose rm