Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,12 @@ The criteria for this are below. Trestle effectively uses a gitflow workflow wit

In trestle's CI environment this results in the following rules:

1. All Commit's *MUST* be signed off with `git commit --signoff` irrespective of the author's affiliation. This ensures all code can be attributed.
1. This is enforced by DCO bot and can be overrided by maintainers presuming at least one commit is signed-off.
1. All Commits *MUST* be signed off with `git commit --signoff` irrespective of the author's affiliation. This ensures all code can be attributed.
1. This is enforced by DCO bot and can be overridden by maintainers presuming at least one commit is signed-off.
1. All commits *SHOULD* use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/)
1. This is as github, when only one commit is in a PR, will use the native git commit message as the merge commit title.
1. When only a single commit is provided the commit MUST be an conventional commit and will be checked the `Lint PR` aciton.
1. All PR's title's MUST be formed as an [convention commit](https://www.conventionalcommits.org/en/v1.0.0-beta.2/)
1. When only a single commit is provided the commit MUST be an conventional commit and will be checked the `Lint PR` action.
1. All PR's titles MUST be formed as a [conventional commit](https://www.conventionalcommits.org/en/v1.0.0-beta.2/)
1. This is checked by the `Lint PR` action
1. All PR's to `develop` and hotfix PR's to `main` must close at least one issue by [linking the PR to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
1. Trestle will release on demand the default approach for a hot fix should be to merge into `develop`, followed by releasing to `main`, unless this will release functionality that is not ready.
Expand Down Expand Up @@ -88,7 +88,7 @@ The devops process does not _strictly_ enforce typing, however, the expectation
commits with a focus on quality over quantity (e.g. don't add `Any` everywhere just to meet coverage requirements).
Python typing of functions is an active work in progress.

`mkbuild` is used to generate the [trestle documenation site](https://oscal-compass.github.io/compliance-trestle/latest). The `mkbuild`
`mkdocs build` is used to generate the [trestle documentation site](https://oscal-compass.github.io/compliance-trestle/latest). The `mkdocs build`
website includes an API reference section generated from the code. Docstrings within the code are expected to follow
[google style docstrings](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html).

Expand Down Expand Up @@ -204,7 +204,7 @@ A PR without sufficient test coverage will fail the trestle CI process and will

Additional code scrutiny is applied in the trestle CI pipeline by [SonarCloud](https://sonarcloud.io/project/overview?id=compliance-trestle). Any failures must be addressed before code merging.

### Code style and formating
### Code style and formatting

Python code should generally follow [PEP 8](https://peps.python.org/pep-0008/).

Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Below shows trestle versions correspondence with OSCAL versions:

```
trestle 4.x => OSCAL 1.2.1
trestle 3.x => OSCAL 1.1.2
trestle 3.x => OSCAL 1.1.3
trestle 2.x => OSCAL 1.0.4
trestle 1.x => OSCAL 1.0.2
trestle 0.37.x => OSCAL 1.0.0
Expand Down Expand Up @@ -73,7 +73,7 @@ python3.11 -m venv venv.trestle
source venv.trestle/bin/activate
pip install compliance-trestle==3.6.0
trestle version
Trestle version v3.6.0 based on OSCAL version 1.1.2
Trestle version v3.6.0 based on OSCAL version 1.1.3
```

## Why Trestle
Expand Down Expand Up @@ -112,7 +112,7 @@ Trestle runs on most all python platforms (e.g. Linux, Mac, Windows) and is avai

## Development status

Compliance trestle is currently stable and is based on NIST OSCAL version 1.1.2, with active development continuing.
Compliance trestle is currently stable and is based on NIST OSCAL version 1.2.1, with active development continuing.

## Contributing to Trestle

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/introduction_to_trestle.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ As a reminder, you could also have imported the file from a local directory on y

The `import` command will also check the
validity of the file including the presence of any duplicate uuid's. If the file is manually created
please be sure it conforms with the current OSCAL schema (OSCAL version 1.0.4) and has no defined uuid's that are duplicates.
please be sure it conforms with the current OSCAL schema (OSCAL version 1.2.1) and has no defined uuid's that are duplicates.
If there are any errors the Import will fail and the file must be corrected.

<br>
Expand Down
Loading