oscal-compass / compliance-trestle

An opinionated tooling platform for managing compliance as code, using continuous integration and NIST's OSCAL standard.

https://oscal-compass.github.io/compliance-trestle

Apache License 2.0

152 stars 56 forks source link

fix: improve trestle v3 README important info #1592

Closed degenaro closed 1 week ago

degenaro commented 2 weeks ago

Types of changes

[ ] Hot fix (emergency fix and release)
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[x] Documentation (change which affects the documentation site)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[ ] Release (develop -> main)

Quality assurance (all should be covered).

[ ] My code follows the code style of this project.
[x] Documentation for my change is up to date?
[ ] My PR meets testing requirements.
[ ] All new and existing tests passed.
[ ] All commits are signed-off.

Summary

Fixes #1591

Key links:

Sonar coverage

Before you merge

Ensure it is a 'squash commit' if not a release.
Ensure CI is currently passing
Check sonar. If you are working for a fork a maintainer will reach out, if required.

degenaro commented 2 weeks ago

Note: added developer-oriented OSCAL upgrade process info, with link from main README.md

degenaro commented 2 weeks ago

@jpower432 Your points are well taken.