diff --git a/README.md b/README.md index 5049254..b301ffa 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,9 @@ A lightweight C# library for programmatically creating test result files in TRX - 📦 **NuGet Ready** - Easy integration via NuGet package - 📊 **Multiple Formats** - Supports both TRX and JUnit XML formats - ✅ **Compatible** - Works with Visual Studio, Azure DevOps, and CI/CD systems +- 🔒 **Continuous Compliance** - Compliance evidence generated automatically on every CI run, + following the [Continuous Compliance](https://github.com/demaconsulting/ContinuousCompliance) + methodology ## Installation diff --git a/docs/guide/guide.md b/docs/guide/guide.md index c75ace6..564b2b0 100644 --- a/docs/guide/guide.md +++ b/docs/guide/guide.md @@ -50,6 +50,20 @@ This library is ideal for: - 📦 **Easy Integration**: Available as a NuGet package - ✅ **Standards Compliant**: Generates files compatible with industry-standard tools +# Continuous Compliance + +The TestResults library follows the [Continuous Compliance][continuous-compliance] methodology, +which ensures compliance evidence is generated automatically on every CI run. + +## Key Practices + +- **Requirements Traceability**: Every requirement is linked to passing tests, and a trace matrix + is auto-generated on each release +- **Linting Enforcement**: markdownlint, cspell, and yamllint are enforced before any build proceeds +- **Automated Audit Documentation**: Each release ships with generated requirements, justifications, + trace matrix, and quality reports +- **CodeQL and SonarCloud**: Security and quality analysis runs on every build + # Prerequisites ## Required Tools @@ -1127,3 +1141,6 @@ Now that you've learned how to use the TestResults library, you can: 5. **Get support**: Ask questions in [GitHub Discussions](https://github.com/demaconsulting/TestResults/discussions) Happy testing! 🎉 + + +[continuous-compliance]: https://github.com/demaconsulting/ContinuousCompliance