From e9a1879412b6f21b520086eb85c67fca7db74c69 Mon Sep 17 00:00:00 2001 From: Nathan Currie Date: Wed, 15 Apr 2026 12:54:26 -0400 Subject: [PATCH 01/10] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 51 +++++++++++++++++++ .../documentation-suggestion.md | 23 +++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 37 ++++++++++++++ 3 files changed, 111 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation-suggestion.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..d78fd6955 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,51 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[Bug]" +labels: bug +assignees: '' +type: Bug + +--- + +## Bug Description +A clear and concise description of what the bug is. + +## Environment & Deployment Context +Please provide details about your deployment to help us reproduce the issue. + +* **Stellar Engine Version/Commit:** (e.g., `main` branch at commit `xxxxxx`, or a specific release tag) +* **Deployment Type:** + * [ ] FedRAMP High + * [ ] DoD IL5 + * [ ] DoD IL4 + * [ ] Stand-alone / Custom +* **FAST Stage (if applicable):** + * [ ] Stage 0 (Bootstrap) + * [ ] Stage 1 (Resource Management) + * [ ] Stage 2 (Network Creation) + * [ ] Stage 3 (Security & Audit) +* **Affected Component:** (e.g., `modules/net-vpc`, `blueprints/il5/bigquery`, `fast/stage-1`) +* **Terraform Version:** (e.g., `1.5.7`) +* **GCP Provider Version:** (e.g., `5.10.0`) + +## Steps to Reproduce +Steps to reproduce the behavior: +1. Go to '...' +2. Run command '...' +3. See error '...' + +## Expected Behavior +A clear and concise description of what you expected to happen. + +## Actual Behavior +A clear and concise description of what actually happened. + +## Relevant Logs and Errors +Please include any relevant logs or error messages from Terraform or GCP. +``` +... +``` + +## Additional Context +Add any other context about the problem here. E.g., does this block a specific compliance control (NIST 800-53r5)? diff --git a/.github/ISSUE_TEMPLATE/documentation-suggestion.md b/.github/ISSUE_TEMPLATE/documentation-suggestion.md new file mode 100644 index 000000000..ace21388f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-suggestion.md @@ -0,0 +1,23 @@ +--- +name: Documentation Suggestion +about: Suggest improvements or additions to the documentation +title: "[Docs]" +labels: documentation +assignees: '' + +--- + +## Description of Documentation Need +What needs to be documented or updated? + +## Target Audience +Who is this documentation for? (e.g., Operators, Security Auditors, Developers). + +## Proposed Location +Where should this documentation live? (e.g., existing file in `docs/`, a new file, or within a module's `README.md`). + +## Content Outline / Draft +Please provide a draft or outline of the content you would like to add. + +## Compliance Context (if applicable) +Does this documentation relate to a specific compliance regime (FedRAMP High, IL5) or NIST control? diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..07f0d9374 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,37 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[Feature Request]" +labels: enhancement +assignees: '' +type: Feature + +--- + +## Feature Description +A clear and concise description of what the feature is. + +## Use Case +Why is this feature needed? What problem does it solve? + +## Proposed Solution +A clear and concise description of what you want to happen. + +## Compliance & Deployment Context +* **Target Deployment Type(s):** + * [ ] FedRAMP High + * [ ] DoD IL5 + * [ ] DoD IL4 + * [ ] All / General +* **Relevant NIST 800-53r5 Controls:** (If applicable, list the controls this feature helps satisfy) + +## Reusability Check +Stellar Engine prioritizes reusability. +* [ ] I have checked if this functionality can be achieved by extending an existing module or blueprint. +* [ ] I have verified that this does not duplicate existing functionality. + +## Alternatives Considered +A clear and concise description of any alternative solutions or features you've considered. + +## Additional Context +Add any other context or screenshots about the feature request here. From 2c5c39d5ad0dee8f6e2cb1613e17c93d05861647 Mon Sep 17 00:00:00 2001 From: Nathan Currie Date: Wed, 15 Apr 2026 12:58:45 -0400 Subject: [PATCH 02/10] Create pull_request_template.md --- .github/pull_request_template.md | 40 ++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..e7cfbf46b --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,40 @@ +## Description +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. + +Fixes # (issue) + +## Type of Change +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update + +## Deployment & Compliance Impact +* **Applicable Regimes:** + * [ ] FedRAMP High + * [ ] DoD IL5 + * [ ] DoD IL4 + * [ ] General / All +* **NIST 800-53r5 Controls:** (If this PR helps satisfy or modifies control implementations, list them here) + +## Checklist + +### Code Quality & Reusability +- [ ] My code adheres to the **Maximize Reusability** principle. I have not redefined common elements and have reused existing base configurations and modules where possible. +- [ ] I have checked that no existing module or configuration in `modules/` or `fast/` can be leveraged for this change. +- [ ] My code follows the established naming conventions outlined in `documentation/naming-convention.md`. + +### Documentation +- [ ] I have updated the `README.md` of the modified module or blueprint. +- [ ] I have added/updated documentation for inputs (variables) and outputs. + +### Security +- [ ] My change adheres to GCP security best practices and the principle of least privilege. +- [ ] I have ensured compliance with the targeted regime (FedRAMP High, IL5, etc.). + +### Testing +- [ ] I have tested my changes locally. +- [ ] I have included details of my testing in this PR. + +## Testing Performed +Please describe the tests that you ran to verify your changes. From 0ad60510e407336b94883f0eb8e8c61504902bb2 Mon Sep 17 00:00:00 2001 From: Nathan Currie Date: Wed, 15 Apr 2026 14:04:59 -0400 Subject: [PATCH 03/10] Update .github/ISSUE_TEMPLATE/documentation-suggestion.md Co-authored-by: Alijohn Ghassemlouei --- .github/ISSUE_TEMPLATE/documentation-suggestion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/documentation-suggestion.md b/.github/ISSUE_TEMPLATE/documentation-suggestion.md index ace21388f..d8e1a7b2f 100644 --- a/.github/ISSUE_TEMPLATE/documentation-suggestion.md +++ b/.github/ISSUE_TEMPLATE/documentation-suggestion.md @@ -1,7 +1,7 @@ --- name: Documentation Suggestion about: Suggest improvements or additions to the documentation -title: "[Docs]" +title: "[Documentation]" labels: documentation assignees: '' From d5dda09bb02db2e22eb1d426f08d31b55e54c270 Mon Sep 17 00:00:00 2001 From: Nathan Currie Date: Wed, 15 Apr 2026 14:05:23 -0400 Subject: [PATCH 04/10] Update .github/pull_request_template.md Co-authored-by: Alijohn Ghassemlouei --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e7cfbf46b..c6c84a429 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,7 +1,7 @@ ## Description Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. -Fixes # (issue) +Fixes # (GitHub issue id) ## Type of Change - [ ] Bug fix (non-breaking change which fixes an issue) From 1c775adf305e8aa8de75c838e0433bdb4ea1f0c9 Mon Sep 17 00:00:00 2001 From: Nathan Currie Date: Wed, 15 Apr 2026 15:51:19 -0400 Subject: [PATCH 05/10] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d78fd6955..1fef097f7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -19,6 +19,8 @@ Please provide details about your deployment to help us reproduce the issue. * [ ] FedRAMP High * [ ] DoD IL5 * [ ] DoD IL4 + * [ ] FedRAMP Moderate + * [ ] US Region Restricted (e.g., Access Policy constraint) * [ ] Stand-alone / Custom * **FAST Stage (if applicable):** * [ ] Stage 0 (Bootstrap) From 6e6a24ef5d2d07dece7a9a72c9359ef16bf7c1c9 Mon Sep 17 00:00:00 2001 From: Alijohn Ghassemlouei Date: Wed, 15 Apr 2026 17:05:37 -0400 Subject: [PATCH 06/10] Update feature request template for compliance options --- .github/ISSUE_TEMPLATE/feature_request.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 07f0d9374..33a882281 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -19,9 +19,11 @@ A clear and concise description of what you want to happen. ## Compliance & Deployment Context * **Target Deployment Type(s):** + * [ ] US Regions + * [ ] FedRAMP Medium * [ ] FedRAMP High - * [ ] DoD IL5 * [ ] DoD IL4 + * [ ] DoD IL5 * [ ] All / General * **Relevant NIST 800-53r5 Controls:** (If applicable, list the controls this feature helps satisfy) From 69a3fcf67e3351386bd588e6a0a67f7fd4f2e4c7 Mon Sep 17 00:00:00 2001 From: Alijohn Ghassemlouei Date: Wed, 15 Apr 2026 17:07:29 -0400 Subject: [PATCH 07/10] Refine bug report template formatting and text Updated formatting and wording in the bug report template for clarity. --- .github/ISSUE_TEMPLATE/bug_report.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 1fef097f7..2f6e06ece 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,22 +11,22 @@ type: Bug ## Bug Description A clear and concise description of what the bug is. -## Environment & Deployment Context +## Environment and Deployment Context Please provide details about your deployment to help us reproduce the issue. -* **Stellar Engine Version/Commit:** (e.g., `main` branch at commit `xxxxxx`, or a specific release tag) +* **Stellar Engine Version/Commit:** e.g., `main` branch at commit `xxxxxx`, or a specific release tag * **Deployment Type:** + * [ ] US Region Restricted (e.g., Access Policy constraint) + * [ ] FedRAMP Medium * [ ] FedRAMP High - * [ ] DoD IL5 * [ ] DoD IL4 - * [ ] FedRAMP Moderate - * [ ] US Region Restricted (e.g., Access Policy constraint) + * [ ] DoD IL5 * [ ] Stand-alone / Custom * **FAST Stage (if applicable):** * [ ] Stage 0 (Bootstrap) * [ ] Stage 1 (Resource Management) * [ ] Stage 2 (Network Creation) - * [ ] Stage 3 (Security & Audit) + * [ ] Stage 3 (Security and Audit) * **Affected Component:** (e.g., `modules/net-vpc`, `blueprints/il5/bigquery`, `fast/stage-1`) * **Terraform Version:** (e.g., `1.5.7`) * **GCP Provider Version:** (e.g., `5.10.0`) @@ -50,4 +50,4 @@ Please include any relevant logs or error messages from Terraform or GCP. ``` ## Additional Context -Add any other context about the problem here. E.g., does this block a specific compliance control (NIST 800-53r5)? +Add any other context about the problem here e.g., does this block a specific compliance control (NIST 800-53 R5)? From 5d22d3372287f212feb8f52c1bfb5ef861527870 Mon Sep 17 00:00:00 2001 From: Alijohn Ghassemlouei Date: Wed, 15 Apr 2026 17:08:14 -0400 Subject: [PATCH 08/10] Refine wording in documentation suggestion template Updated phrasing in the documentation suggestion template for clarity. --- .github/ISSUE_TEMPLATE/documentation-suggestion.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/documentation-suggestion.md b/.github/ISSUE_TEMPLATE/documentation-suggestion.md index d8e1a7b2f..c79de6cc4 100644 --- a/.github/ISSUE_TEMPLATE/documentation-suggestion.md +++ b/.github/ISSUE_TEMPLATE/documentation-suggestion.md @@ -11,10 +11,10 @@ assignees: '' What needs to be documented or updated? ## Target Audience -Who is this documentation for? (e.g., Operators, Security Auditors, Developers). +Who is this documentation for? e.g., Operators, Security Auditors, Developers. ## Proposed Location -Where should this documentation live? (e.g., existing file in `docs/`, a new file, or within a module's `README.md`). +Where should this documentation live? e.g., existing file in `docs/`, a new file, or within a module's `README.md`. ## Content Outline / Draft Please provide a draft or outline of the content you would like to add. From 8782619083c2370c55ebc60505fdbbd06bfd02dc Mon Sep 17 00:00:00 2001 From: Alijohn Ghassemlouei Date: Wed, 15 Apr 2026 17:08:46 -0400 Subject: [PATCH 09/10] Update feature_request.md --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 33a882281..8e269024e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -19,7 +19,7 @@ A clear and concise description of what you want to happen. ## Compliance & Deployment Context * **Target Deployment Type(s):** - * [ ] US Regions + * [ ] US Region Restricted (e.g., Access Policy constraint) * [ ] FedRAMP Medium * [ ] FedRAMP High * [ ] DoD IL4 From 91b53199537325dc4b70531fa9e2eee78dd25bc1 Mon Sep 17 00:00:00 2001 From: Alijohn Ghassemlouei Date: Wed, 15 Apr 2026 17:09:28 -0400 Subject: [PATCH 10/10] Update pull request template for compliance items --- .github/pull_request_template.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c6c84a429..0b4060e89 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -11,9 +11,11 @@ Fixes # (GitHub issue id) ## Deployment & Compliance Impact * **Applicable Regimes:** + * [ ] US Region Restricted (e.g., Access Policy constraint) + * [ ] FedRAMP Moderate * [ ] FedRAMP High - * [ ] DoD IL5 * [ ] DoD IL4 + * [ ] DoD IL5 * [ ] General / All * **NIST 800-53r5 Controls:** (If this PR helps satisfy or modifies control implementations, list them here)