Template DotNet Library

DEMA Consulting template project for DotNet Libraries, demonstrating best practices for building reusable .NET libraries.

Features

This template demonstrates:

• Simple Library Structure: Demo class with example methods
• Multi-Platform Support: Builds and runs on Windows, Linux, and macOS
• Multi-Runtime Support: Targets .NET Standard 2.0, .NET 8, 9, and 10
• MSTest V4: Modern unit testing with MSTest framework version 4
• Comprehensive CI/CD: GitHub Actions workflows with quality checks and builds
• Linting Enforcement: markdownlint, cspell, and yamllint enforced on every CI run
• Continuous Compliance: Compliance evidence generated automatically on every CI run, following the Continuous Compliance methodology
• SonarCloud Integration: Quality gate and security analysis on every build
• Documentation Generation: Automated build notes, user guide, code quality reports, requirements, justifications, and trace matrix
• Requirements Traceability: Requirements linked to passing tests with auto-generated trace matrix

Installation

Install the library using the .NET CLI:

dotnet add package TemplateDotNetLibrary

Usage

using TemplateDotNetLibrary;

var demo = new DemoClass();
var result = demo.DemoMethod("World");

Documentation

Generated documentation includes:

• Build Notes: Release information and changes
• User Guide: Comprehensive usage documentation
• Code Quality Report: CodeQL and SonarCloud analysis results
• Requirements: Functional and non-functional requirements
• Requirements Justifications: Detailed requirement rationale
• Trace Matrix: Requirements to test traceability

License

Copyright (c) DEMA Consulting. Licensed under the MIT License. See LICENSE for details.

By contributing to this project, you agree that your contributions will be licensed under the MIT License.