Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated issue templates using GitHub forms
Browse files Browse the repository at this point in the history
david-waltermire committed Nov 30, 2023
1 parent 93ca0e2 commit c9cef8b
Showing 9 changed files with 225 additions and 227 deletions.
51 changes: 0 additions & 51 deletions .github/ISSUE_TEMPLATE/1-feedback.md

This file was deleted.

63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/1-feedback.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Feedback on FedRAMP OSCAL Resources
description: Provide feedback, ask a question, or request an enhancement related to any of the OSCAL-based FedRAMP resources.
title: "[Feedback]: "
labels: ["feedback"]
body:
- type: markdown
attributes:
value: |
Is this report specifically related to [the Word or Excel files from fedramp.gov](fedramp.gov/documents-templates/)? If so, please do not open an issue here. Follow the guidance in [this repository's README](https://github.com/GSA/fedramp-automation#support-and-oscal-deprecation-strategy) and contact [[email protected]](mailto:[email protected]).
- type: markdown
attributes:
value: |
NOTE: For feedback related to the OSCAL syntax itself, please create or add to an [issue in the NIST OSCAL Repository](https://github.com/usnistgov/OSCAL/issues).
- type: dropdown
attributes:
label: This is a ...
options:
- request - need something additional provided
- concern - something needs to be different
- question - need to understand something
- kudos - want to encourage something helpful
validations:
required: true
- type: checkboxes
attributes:
label: This relates to ...
description: Select all things this feedback relates to.
options:
- label: the **FedRAMP OSCAL Registry**
- label: the **Guide to OSCAL-based FedRAMP Content**
- label: the **Guide to OSCAL-based FedRAMP System Security Plans (SSP)**
- label: the **Guide to OSCAL-based FedRAMP Security Assessment Plans (SAP)**
- label: the **Guide to OSCAL-based FedRAMP Security Assessment Results (SAR)**
- label: the **Guide to OSCAL-based FedRAMP Plan of Action and Milestones (POA&M)**
- label: the **FedRAMP SSP OSCAL Template** (JSON or XML Format)
- label: the **FedRAMP SAP OSCAL Template** (JSON or XML Format)
- label: the **FedRAMP SAR OSCAL Template** (JSON or XML Format)
- label: the **FedRAMP POA&M OSCAL Template** (JSON or XML Format)
- label: the **FedRAMP OSCAL Validations**
- type: textarea
attributes:
label: What is your feedback?
description: What action would you like to see from the FedRAMP PMO? Please provide sufficient detail to make your feedback actionable.
placeholder: |
Provide your feedback here.
validations:
required: true
- type: textarea
attributes:
label: Where, exactly?
description: Provide some context about what this feedback relates to.
placeholder: |
- For the registry, please indicate the tab and cell, or other clear identifier
- For the guide, please indicate the section number and printed page number (lower right corner)
- For the OSCAL XML or JSON files, please indicate XML or JSON; and indicate the line number, field id, or other clear location identifier
validations:
required: true
- type: textarea
attributes:
label: Other information
description: Provide any other relevant information.
placeholder: |
detailed explanation, suggestions how to fix, reference to related issues, links providing context, etc.
46 changes: 0 additions & 46 deletions .github/ISSUE_TEMPLATE/2-bug-report.md

This file was deleted.

65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/2-bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Bug report
description: Submit a bug report to help us improve
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Is this report specifically related to [the Word or Excel files from fedramp.gov](fedramp.gov/documents-templates/)? If so, please do not open an issue here. Follow the guidance in [this repository's README](https://github.com/GSA/fedramp-automation#support-and-oscal-deprecation-strategy) and contact [[email protected]](mailto:[email protected]).
- type: markdown
attributes:
value: |
NOTE: For feedback related to the OSCAL syntax itself, please create or add to an [issue in the NIST OSCAL Repository](https://github.com/usnistgov/OSCAL/issues).
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
attributes:
label: This relates to ...
description: Select all things this feedback relates to.
options:
- label: the **FedRAMP OSCAL Registry**
- label: the **Guide to OSCAL-based FedRAMP Content**
- label: the **Guide to OSCAL-based FedRAMP System Security Plans (SSP)**
- label: the **Guide to OSCAL-based FedRAMP Security Assessment Plans (SAP)**
- label: the **Guide to OSCAL-based FedRAMP Security Assessment Results (SAR)**
- label: the **Guide to OSCAL-based FedRAMP Plan of Action and Milestones (POA&M)**
- label: the **FedRAMP SSP OSCAL Template** (JSON or XML Format)
- label: the **FedRAMP SAP OSCAL Template** (JSON or XML Format)
- label: the **FedRAMP SAR OSCAL Template** (JSON or XML Format)
- label: the **FedRAMP POA&M OSCAL Template** (JSON or XML Format)
- label: the **FedRAMP OSCAL Validations**
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: Shell
- type: textarea
id: howto-replicate
attributes:
label: How do we replicate this issue?
description: What are the steps to reproduce this behavior (use screenshots if applicable)?
placeholder: |
1. Do this...
2. Then this...
3. See error...
validations:
required: true
- type: textarea
id: other
attributes:
label: Other relevant details
description: Anything else we should know?
placeholder: |
detailed explanation, suggestions how to fix, reference to related issues, links providing context, etc.
57 changes: 0 additions & 57 deletions .github/ISSUE_TEMPLATE/3-action-item.md

This file was deleted.

82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/3-action-item.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: Request an Action
description: Request something be done
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Is this report specifically related to [the Word or Excel files from fedramp.gov](fedramp.gov/documents-templates/)? If so, please do not open an issue here. Follow the guidance in [this repository's README](https://github.com/GSA/fedramp-automation#support-and-oscal-deprecation-strategy) and contact [[email protected]](mailto:[email protected]).
- type: markdown
attributes:
value: |
NOTE: For feedback related to the OSCAL syntax itself, please create or add to an [issue in the NIST OSCAL Repository](https://github.com/usnistgov/OSCAL/issues).
- type: dropdown
attributes:
label: This is a ...
options:
- fix - something needs to be different
- improvement - something could be better
- research - something needs to be investigated
validations:
required: true
- type: checkboxes
attributes:
label: This relates to ...
description: Select all things this feedback relates to.
options:
- label: the **FedRAMP OSCAL Registry**
- label: the **Guide to OSCAL-based FedRAMP Content**
- label: the **Guide to OSCAL-based FedRAMP System Security Plans (SSP)**
- label: the **Guide to OSCAL-based FedRAMP Security Assessment Plans (SAP)**
- label: the **Guide to OSCAL-based FedRAMP Security Assessment Results (SAR)**
- label: the **Guide to OSCAL-based FedRAMP Plan of Action and Milestones (POA&M)**
- label: the **FedRAMP SSP OSCAL Template** (JSON or XML Format)
- label: the **FedRAMP SAP OSCAL Template** (JSON or XML Format)
- label: the **FedRAMP SAR OSCAL Template** (JSON or XML Format)
- label: the **FedRAMP POA&M OSCAL Template** (JSON or XML Format)
- type: textarea
id: user-story
attributes:
label: User Story
description: Describe why the new feature is needed.
placeholder: |
As a FedRAMP {*stakeholder*}, I *provide a clear and concise description of what the problem is.* Ex. I need to be able to do
validations:
required: true
- type: textarea
id: goals
attributes:
label: Goals
description: Describe what needs to be accomplished to address the User Story.
placeholder: |
A clear and concise description of what you want to happen. This should be outcome focused. Include concise description of any alternative solutions or features you've considered. Feel free to include screenshots or examples about the feature request here.
validations:
required: true
- type: textarea
id: dependencies
attributes:
label: Dependencies
description: Describe any previous issues or related work that must be completed to start or complete this issue.
placeholder: |
Link to any previous issues or related work.
validations:
required: false
- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance Criteria
description: Describe the artifacts and additional work that must be completed to resolve this issue.
placeholder: |
The items below are general acceptance criteria for all User Stories. Please describe anything else that must be completed for this issue to be considered resolved.
value: |
- All FedRAMP Documents Related to OSCAL Adoption (https://github.com/GSA/fedramp-automation) affected by the changes in this issue have been updated.
- A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
validations:
required: false
- type: textarea
attributes:
label: Other information
description: Provide any other relevant information.
placeholder: |
detailed explanation, suggestions how to fix, reference to related issues, links providing context, etc.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/4-schematron-rule-issue.md

This file was deleted.

35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/5-validation-tooling-issue.md

This file was deleted.

15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Committer Notes

{Please provide a description of what this PR accomplishes. Be sure to reference any issues addressed. If the PR is a work-in-progress submitted for early review, please submit the PR as a draft PR using the "Draft pull request" dropdown.}

### All Submissions:

- [ ] Have you selected the correct base branch per [Contributing](https://github.com/GSA/fedramp-automation/blob/master/CONTRIBUTING.md) guidance?
- [ ] Have you set "[Allow edits and access to secrets by maintainers](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)"?
- [ ] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/GSA/fedramp-automation/pulls) for the same update/change?
- [ ] Have you squashed any non-relevant commits and commit messages? \[[instructions](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History)\]
- [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
- [ ] If applicable, have all [FedRAMP Documents Related to OSCAL Adoption](https://github.com/GSA/fedramp-automation) affected by the changes in this issue have been updated.?
- [ ] If applicable, does this PR reference the issue it addresses and explain how it addresses the issue?

By submitting a pull request, you are agreeing to provide this contribution under the [CC0 1.0 Universal public domain](https://creativecommons.org/publicdomain/zero/1.0/) dedication.

0 comments on commit c9cef8b

Please sign in to comment.