Skip to content

Latest commit

 

History

History
22 lines (14 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

22 lines (14 loc) · 1.36 KB

Contributor guide

Versioning

This library uses Nerdbank.GitVersioning for generating stable and reproducible version numbers.

The base version is manually maintained in the version config. Every build calculates its final version number based on the base version and the number of changes that occured since the last change to the version config.

The base version represents the MAJOR and MINOR parts of SemVer. If a PR contains breaking changes or new features the base version has to be changed accordingly. If a PR solely contains minor changes (bug fixes, code improvements) nothing needs to be done as the PATCH number will automatically increment with each commit.

Branches / tags

  • master contains the latest sources - this is where we develop.
  • release contains the sources for the latest version on nuget.org - this is where we deploy from.
  • All versions on nuget.org have a matching GitHub release/tag

Release workflow

  1. Create a PR from master to release and wait for CI to finish.
  2. Inspect CI run (test results, version number)
  3. Merge PR and wait for deployment
  4. Inspect newly created package versions on NuGet.org and newly created GitHub release