diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..2f6e06ece --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,53 @@ +--- +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 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 +* **Deployment Type:** + * [ ] US Region Restricted (e.g., Access Policy constraint) + * [ ] FedRAMP Medium + * [ ] FedRAMP High + * [ ] DoD IL4 + * [ ] DoD IL5 + * [ ] Stand-alone / Custom +* **FAST Stage (if applicable):** + * [ ] Stage 0 (Bootstrap) + * [ ] Stage 1 (Resource Management) + * [ ] Stage 2 (Network Creation) + * [ ] 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`) + +## 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-53 R5)? diff --git a/.github/ISSUE_TEMPLATE/documentation-suggestion.md b/.github/ISSUE_TEMPLATE/documentation-suggestion.md new file mode 100644 index 000000000..c79de6cc4 --- /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: "[Documentation]" +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..8e269024e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,39 @@ +--- +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):** + * [ ] US Region Restricted (e.g., Access Policy constraint) + * [ ] FedRAMP Medium + * [ ] FedRAMP High + * [ ] DoD IL4 + * [ ] DoD IL5 + * [ ] 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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..0b4060e89 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,42 @@ +## Description +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. + +Fixes # (GitHub issue id) + +## 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:** + * [ ] US Region Restricted (e.g., Access Policy constraint) + * [ ] FedRAMP Moderate + * [ ] FedRAMP High + * [ ] DoD IL4 + * [ ] DoD IL5 + * [ ] 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.