Skip to content

local-development.md

Latest commit

 

History

History
95 lines (64 loc) · 2.76 KB

local-development.md

File metadata and controls

95 lines (64 loc) · 2.76 KB
Raw

Local Development

This guide explains how to build, test, and format the PolylineAlgorithm codebase locally.

Prerequisites

Building

Build the main library using the solution file:

dotnet build PolylineAlgorithm.slnx

To build in Release configuration (required before running tests or benchmarks):

dotnet build PolylineAlgorithm.slnx --configuration Release

Running Tests

Run all unit tests:

dotnet test ./tests/PolylineAlgorithm.Tests/PolylineAlgorithm.Tests.csproj --configuration Release

Note: Always use Release configuration when running tests. The Debug configuration contains a Debug.Assert in AbstractPolylineEncoderTest that will crash the test runner.

To collect code coverage at the same time:

dotnet test ./tests/PolylineAlgorithm.Tests/PolylineAlgorithm.Tests.csproj \
  --configuration Release \
  --coverage \
  --coverage-output-format cobertura \
  --coverage-settings ./code-coverage-settings.xml

Running Benchmarks

See Benchmarks for full details. Quick run:

dotnet run --project ./benchmarks/PolylineAlgorithm.Benchmarks/PolylineAlgorithm.Benchmarks.csproj \
  --configuration Release \
  --framework net10.0 \
  -- --filter '*'

Formatting

The project uses dotnet format for code style enforcement. Run all format steps before committing:

# Fix whitespace
dotnet format whitespace

# Fix code style
dotnet format style

# Fix analyzer warnings (optional — run when you want to fix diagnostics)
dotnet format analyzers

The CI format job also runs dotnet format automatically on every push to non-release branches and pushes the formatted result back to the branch.

Editor Configuration

Code style rules are stored in .editorconfig at the repository root. Any compliant IDE (Visual Studio, VS Code with C# Dev Kit, Rider) will pick these up automatically.

Required Repository Secrets and Variables

The CI/CD workflows rely on the following GitHub repository secrets and variables.

Secrets

Name Description
NUGET_PACKAGE_FEED_API_KEY API key for the Azure Artifacts NuGet feed

Variables

Name Description
NUGET_PACKAGE_FEED_URL NuGet feed URL
BENCHMARKDOTNET_RUN_OVERRIDE Set to true to force benchmarks to run on non-release PRs
BENCHMARKDOTNET_RUNTIMES Runtimes to benchmark (e.g. net8.0 net10.0)
BENCHMARKDOTNET_FILTER Benchmark filter pattern (e.g. *)
DEFAULT_BUILD_FRAMEWORK Default target framework for builds (e.g. net10.0)
SRC_DEFAULT_GLOB_PATTERN Glob pattern for source project files (e.g. **/PolylineAlgorithm.csproj)