-
Notifications
You must be signed in to change notification settings - Fork 2
Update issue templates #23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+157
−0
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
e9a1879
Update issue templates
ncurrie3 2c5c39d
Create pull_request_template.md
ncurrie3 0ad6051
Update .github/ISSUE_TEMPLATE/documentation-suggestion.md
ncurrie3 d5dda09
Update .github/pull_request_template.md
ncurrie3 1c775ad
Update bug_report.md
ncurrie3 6e6a24e
Update feature request template for compliance options
aghassemlouei 69a3fcf
Refine bug report template formatting and text
aghassemlouei 5d22d33
Refine wording in documentation suggestion template
aghassemlouei 8782619
Update feature_request.md
aghassemlouei 91b5319
Update pull request template for compliance items
aghassemlouei File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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)? | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.