Developers Experience

We welcome contributions to ReqIFSharp: bug reports, documentation fixes and pull requests alike. Please read the contribution guidelines. They explain how to make a pull request and which code style to follow.

Build and test locally

You need the .NET 10 SDK. The libraries target netstandard2.0, the test projects target net10.0.

git clone https://github.com/STARIONGROUP/reqifsharp.git
cd reqifsharp
dotnet build ReqIFSharp.sln
dotnet test ReqIFSharp.sln

Run one test fixture, or collect coverage:

dotnet test --filter "FullyQualifiedName~ReqIFDeSerializerTestFixture"
dotnet test ReqIFSharp.sln --settings coverlet.runsettings

See Development Environment for IDEs and the layout of the solution.

Branches

development is the main branch: create your branch from it and send pull requests to it. master follows the latest release.

Tickets and code review

GitHub issues are used to report bugs and plan work. Every change is reviewed in a pull request.

Changelog

Every change that affects users of the packages adds a line under ## [Unreleased] in CHANGELOG.md, in the same pull request. The file follows Keep a Changelog:

Use the groups Added, Changed, Deprecated, Removed, Fixed and Security.
Link the issue or pull request.
Start lines that only concern ReqIFSharp.Extensions with "ReqIFSharp.Extensions:".
Mark breaking changes with Breaking:.

Contributor License Agreement

Before we can accept a code contribution, we ask contributors to sign the Contributor License Agreement (CLA) and send it digitally signed to s.gerene@stariongroup.eu. The CLAs are in the CLA folder.

Continuous integration

GitHub Actions run on every push and pull request:

Build & Test & SonarQube: build, unit tests, coverage and SonarQube quality analysis
CodeQL: semantic code analysis to find security vulnerabilities
NuGet reference check: checks the package references of the solution