|
1 | 1 | # Pull Request Checklist |
2 | 2 |
|
3 | | -> Take your time to read through these, don't just click through them. Only check the boxes if they apply. |
| 3 | +> Please take a moment to review this checklist carefully — only check items that genuinely apply. This helps maintain code quality, traceability, and review integrity. |
| 4 | +
|
| 5 | +--- |
4 | 6 |
|
5 | 7 | ## Admin |
6 | | -<!--- Ensure --> |
7 | 8 | - [ ] **Required:** I have read the [contributing guidelines](https://coalfire.atlassian.net/wiki/spaces/CEHOME/pages/2648440862/Pull+Request+Best+Practices) for submitting a PR. |
8 | 9 |
|
9 | | -## Types of changes |
10 | | -<!--- What types of changes does your code introduce? --> |
11 | | -- [ ] :bug: Bug fix (non-breaking change which fixes an issue) |
12 | | -- [ ] :sparkle: New feature (non-breaking change which adds functionality) |
13 | | -- [ ] :collision: Breaking change (fix or feature that would cause existing functionality to change) |
| 10 | +--- |
| 11 | + |
| 12 | +## Types of Changes (Required Conventional Commits) |
| 13 | +> We follow **Conventional Commits** to keep history readable and automate changelogs/releases. |
| 14 | +> Use `!` after the type (e.g., `feat!:` or `fix!:`) to indicate a **breaking change**. |
| 15 | +
|
| 16 | +- [ ] **feat:** Introduces a new feature or capability for users. |
| 17 | +- [ ] **fix:** Resolves a bug or unintended behavior. |
| 18 | +- [ ] **chore:** Maintenance or tooling changes that don’t affect runtime behavior. |
| 19 | +- [ ] **docs:** Documentation-only changes (README, comments, wiki, etc.). |
| 20 | +- [ ] **refactor:** Code restructuring that doesn’t change functionality. |
| 21 | +- [ ] **test:** Adds or updates tests without changing production code. |
| 22 | +- [ ] **ci:** Updates to CI/CD pipelines or automation workflows. |
| 23 | + |
| 24 | +--- |
| 25 | + |
| 26 | +## AI Assistance Disclosure (Required) |
| 27 | +> We encourage responsible AI usage. Disclosure helps reviewers apply extra scrutiny to prevent hallucinations, logic errors, or insecure patterns. |
| 28 | +
|
| 29 | +- [ ] **I used AI assistance while creating this PR** |
| 30 | +- [ ] **I did NOT use AI assistance for this PR** |
| 31 | + |
| 32 | +If AI was used, briefly describe: |
| 33 | +- What tools were used (e.g., ChatGPT, Copilot, Claude) |
| 34 | +- What it helped with (e.g., refactoring, test generation, docs) |
| 35 | +- Any areas that may require extra review |
| 36 | + |
| 37 | +<!-- Example: “Used ChatGPT to refactor Terraform locals — manually validated logic and security.” --> |
| 38 | + |
| 39 | +--- |
14 | 40 |
|
15 | 41 | ## Testing |
16 | 42 |
|
17 | | -- [ ] **Required:** I have tested the proposed changes to code (i.e. `packer build`, `terraform apply`), and they are working. |
18 | | -- [ ] **Required:** All GitHub Actions ran successfully. If they didn't, I left a note in the description to address this. |
19 | | -- [ ] **Optional:** I have already applied/deployed the changes in my environment. |
| 43 | +- [ ] **Required:** I tested the proposed changes (e.g., `terraform apply`, `packer build`, app runtime tests). |
| 44 | +- [ ] **Required:** All GitHub Actions checks passed, or failures are documented in the PR description. |
| 45 | +- [ ] **Optional:** I have already deployed or validated this change in a real environment. |
20 | 46 |
|
21 | | -### Please check where this code has been tested |
| 47 | +### Tested In: |
| 48 | +- [ ] Local development environment |
| 49 | +- [ ] Customer environment |
| 50 | +- [ ] Coalfire Sandbox (AWS GovCloud, Azure Gov, GCP, etc.) |
22 | 51 |
|
23 | | -- [ ] Locally |
24 | | -- [ ] Customer Environment |
25 | | -- [ ] Coalfire Sandbox Environment (AWS GovCloud, Azure Gov, GCP, etc.) |
| 52 | +--- |
26 | 53 |
|
27 | 54 | ## Documentation |
28 | 55 |
|
29 | | -- [ ] **Optional, recommended:** I have updated ***`README.md`***. |
30 | | -- [ ] **Optional, recommended:** I have updated documentation in ***Confluence/Organization's relevant Wiki***. |
31 | | -- [ ] **Optional, recommended:** I left comments ***in-line in the code*** to help others understand the changes. |
| 56 | +- [ ] **Recommended:** Updated ***README.md*** where applicable |
| 57 | +- [ ] **Recommended:** Updated relevant ***Confluence / Wiki*** documentation |
| 58 | +- [ ] **Recommended:** Added inline comments or context for complex logic |
| 59 | + |
| 60 | +--- |
| 61 | + |
| 62 | +## Tagging / Ownership |
| 63 | + |
| 64 | +- [ ] **Required:** Reviewer(s) assigned |
| 65 | +- [ ] **Required:** Assignee(s) assigned |
| 66 | +- [ ] **Optional:** Relevant stakeholders notified via comment |
| 67 | + |
| 68 | +--- |
32 | 69 |
|
33 | | -## Tagging / Assigning |
| 70 | +## Optional: Reviewer Guidance |
| 71 | +> Call out risky areas, architectural decisions, or areas needing deeper review. |
34 | 72 |
|
35 | | -- [ ] **Required:** I have tagged a ***Reviewer(s)***. |
36 | | -- [ ] **Required:** I have tagged an ***Assignee(s)***. |
37 | | -- [ ] **Optional:** I have tagged relevant stakeholders in a ***Comment***. |
| 73 | +<!-- Example: “Please focus review on auth middleware changes and IAM policy updates.” --> |
0 commit comments