DEMA Consulting template project for DotNet Libraries, demonstrating best practices for building reusable .NET libraries.
The diagram below is a placeholder: replace its TODO boxes to show how an application calls your library's subsystems, which inputs it takes, and which outputs it produces.
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, 10, and 11
- xUnit v3: Modern unit testing with xUnit framework version 3
- Comprehensive CI/CD: GitHub Actions workflows with quality checks and builds
- Linting Enforcement: markdownlint, TextLint, 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
Install the library using the .NET CLI:
dotnet add package TemplateDotNetLibraryusing TemplateDotNetLibrary;
var demo = new Demo();
var result = demo.DemoMethod("World"); // result = "Hello, World!"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
Contributions are welcome. See CONTRIBUTING.md for development setup, coding standards, and the pull request process.
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.