Skip to content

Commit 28cf20c

Browse files
Champbreeddegenaro
andauthored
docs: add code review policy and update security insights #1844 (#2134)
* docs: add code review policy and update security insights #1844 Signed-off-by: Simon Essien <champbreed1@gmail.com> * docs: implement code review policy #1844 Signed-off-by: Simon Essien <champbreed1@gmail.com> * style: fix markdown formatting nits via mdformat Signed-off-by: Simon Essien <champbreed1@gmail.com> * docs: sync maintainers with core team and update security insights Signed-off-by: Simon Essien <champbreed1@gmail.com> --------- Signed-off-by: Simon Essien <champbreed1@gmail.com> Co-authored-by: Lou DeGenaro <lou.degenaro@gmail.com>
1 parent 4f6c77c commit 28cf20c

2 files changed

Lines changed: 33 additions & 8 deletions

File tree

.github/security-insights.yml

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
header:
22
schema-version: 2.0.0
3-
last-updated: '2025-03-20'
4-
last-reviewed: '2025-03-20'
3+
last-updated: '2026-04-17'
4+
last-reviewed: '2026-04-17'
55
url: https://github.com/oscal-compass/compliance-trestle/blob/develop/.github/security-insights.yml
66
project-si-source: https://raw.githubusercontent.com/oscal-compass/.github/refs/heads/main/.github/security-insights.yml
77
comment: |
@@ -17,21 +17,16 @@ repository:
1717
# From the complaince-trestle MAINTAINER.md file
1818
# https://github.com/oscal-compass/compliance-trestle/blob/develop/MAINTAINERS.md
1919
core-team:
20-
- name: Alejandro Jose Leiva Palomo
21-
primary: true
2220
- name: Christopher Butler
2321
primary: true
2422
- name: Lou Degenaro
2523
primary: true
26-
- name: Jennifer Power
27-
primary: true
28-
- name: Manjiree Gadgil
29-
primary: true
3024
- name: Vikas Agarwal
3125
primary: true
3226
documentation:
3327
contributing-guide: https://github.com/oscal-compass/compliance-trestle/blob/develop/CONTRIBUTING.md
3428
security-policy: https://github.com/oscal-compass/community/blob/main/SECURITY.md
29+
review-policy: https://github.com/oscal-compass/compliance-trestle/blob/develop/docs/code-review-policy.md
3530
license:
3631
url: https://github.com/oscal-compass/compliance-trestle/blob/develop/LICENSE
3732
expression: Apache-2.0

docs/code-review-policy.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Code Review Policy
2+
3+
This document outlines the mandatory quality assurance checks and standards for all contributions to Compliance Trestle, as required by OSPS-GV-03.02.
4+
5+
## Review Requirements
6+
7+
All Pull Requests must satisfy the following criteria before they are eligible for merging. Technical setup and legal requirements (such as DCO sign-off and license headers) are maintained in the [OSCAL Compass Community CONTRIBUTING guide](https://github.com/oscal-compass/community/blob/main/CONTRIBUTING.md).
8+
9+
### 1. Quality Assurance
10+
11+
- **Code style:** Contributions must adhere to project-specific formatting (PEP 8 via yapf/flake8).
12+
- **Documentation:** Changes must include updated documentation following Google-style docstrings.
13+
- **Testing:** PRs must meet the project-configured code coverage threshold of **96%**. Reviewers must verify that new tests cover logic edge cases.
14+
- **CI gates:** All automated checks must pass, including the **SonarCloud** scan for code quality and security vulnerabilities. SonarCloud is a mandatory gate — no PR may be merged while SonarCloud checks are failing.
15+
16+
### 2. Review Standards
17+
18+
- **Reviewer count:** In accordance with the project's governance, every PR requires at least **two (2) LGTMs** (Looks Good To Me) before merging. At least one of these reviewers must be a designated **Code Owner**.
19+
- **Logic verification:** Reviewers must verify that the change is functionally sound and does not introduce security vulnerabilities or logic regressions.
20+
- **Maintainability:** Code should be reviewed for complexity; reviewers are encouraged to suggest simplifications to promote long-term maintainability and readability.
21+
- **Issue alignment:** Every PR must be linked to a tracked issue to maintain the project's audit trail for compliance.
22+
23+
### 3. Submission Workflow
24+
25+
- **Commit history:** In alignment with the community guide, all merges into the `develop` branch MUST be conducted via a **squash-merge**.
26+
- **Audit trail:** Reviewers are responsible for verifying that the final squash message provides a clear description of the functional changes to ensure a clean, searchable history for auditing.
27+
28+
## Security Oversight
29+
30+
In accordance with OSPS-GV-03.02, this policy ensures that every code change undergoes a rigorous review to maintain the security posture of the Compliance Trestle ecosystem.

0 commit comments

Comments
 (0)