|
| 1 | +name: Add, Change, or Remove a Constraint |
| 2 | +description: Define work to be performed specifically related to the adding, changing, or removing constraints. |
| 3 | +labels: ["enhancement"] |
| 4 | +body: |
| 5 | + - type: textarea |
| 6 | + id: user-story |
| 7 | + attributes: |
| 8 | + label: Constraint Task |
| 9 | + description: Identify the constraint |
| 10 | + placeholder: | |
| 11 | + Consistent with the parent/tracked-by issue, this constraint work focuses on ... |
| 12 | + validations: |
| 13 | + required: true |
| 14 | + |
| 15 | + - type: textarea |
| 16 | + id: intended-outcome |
| 17 | + attributes: |
| 18 | + label: Intended Outcome |
| 19 | + description: Describe the reason for the constraint |
| 20 | + placeholder: | |
| 21 | + Ensure the {*content*} is ... |
| 22 | + validations: |
| 23 | + required: true |
| 24 | + |
| 25 | + - type: markdown |
| 26 | + attributes: |
| 27 | + value: OSCAL Content Details |
| 28 | + |
| 29 | + - type: dropdown |
| 30 | + attributes: |
| 31 | + label: Syntax Type |
| 32 | + options: |
| 33 | + - This is required core OSCAL syntax. |
| 34 | + - This is optional core OSCAL syntax. |
| 35 | + - This is a FedRAMP constraint in the FedRAMP-specific namespace. |
| 36 | + - This is a mix of required, optional, and/or extended syntax. |
| 37 | + - Not sure, can maintainers help me choose? |
| 38 | + validations: |
| 39 | + required: true |
| 40 | + |
| 41 | + - type: dropdown |
| 42 | + attributes: |
| 43 | + label: Allowed Values |
| 44 | + options: |
| 45 | + - There are no relevant allowed values. |
| 46 | + - There are only NIST-defined allowed values. |
| 47 | + - FedRAMP allowed values must be defined or verified. |
| 48 | + - NIST-allowed values must be extended with FedRAMP allowed values. |
| 49 | + - Not sure, can maintainers help me choose? |
| 50 | + validations: |
| 51 | + required: true |
| 52 | + |
| 53 | + - type: textarea |
| 54 | + id: metapath |
| 55 | + attributes: |
| 56 | + label: Metapath(s) to Content |
| 57 | + description: Provide the metapath/xpath to the OSCAL conent. This will be automatically formatted into code, so no need for backticks. |
| 58 | + render: xslt |
| 59 | + validations: |
| 60 | + required: true |
| 61 | + |
| 62 | + |
| 63 | + - type: textarea |
| 64 | + id: purpose |
| 65 | + attributes: |
| 66 | + label: Purpose of the OSCAL Content |
| 67 | + description: Describe how the OSCAL content is used by FedRAMP Reviewers. |
| 68 | + placeholder: | |
| 69 | + Provide information that explains why the constraint is important |
| 70 | + validations: |
| 71 | + required: false |
| 72 | + |
| 73 | + - type: textarea |
| 74 | + id: dependencies |
| 75 | + attributes: |
| 76 | + label: Dependencies |
| 77 | + description: Describe any previous issues or related work that must be completed to start or complete this issue. |
| 78 | + placeholder: | |
| 79 | + Link to any previous issues or related work. |
| 80 | + validations: |
| 81 | + required: false |
| 82 | + |
| 83 | + - type: textarea |
| 84 | + id: acceptance-criteria |
| 85 | + attributes: |
| 86 | + label: Acceptance Criteria |
| 87 | + description: Describe the artifacts and additional work that must be completed to resolve this issue. |
| 88 | + placeholder: | |
| 89 | + 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. |
| 90 | + value: | |
| 91 | + - [ ] All [OSCAL adoption content](http://automate.fedramp.gov/) affected by the change in this issue have been updated in accordance with the Documentation Standards. |
| 92 | + - [ ] Explanation is present and accurate |
| 93 | + - [ ] sample content is present and accurate |
| 94 | + - [ ] [Metapath](https://pages.nist.gov/metaschema/specification/syntax/metapath/) is present, accurate, and does not throw a syntax exception using `oscal-cli metaschema metapath eval -e "expression"`. |
| 95 | + - [ ] All constraints associated with the review task have been created |
| 96 | + - [ ] The appropriate example OSCAL file is updated with content that demonstrates the FedRAMP-compliant OSCAL presentation. |
| 97 | + - [ ] The constraint conforms to the FedRAMP Constraint Style Guide. |
| 98 | + - [ ] All automated and manual review items that identify non-conformance are addressed; **or** technical leads (David Waltermire; AJ Stein) have approved the PR and “override” the style guide requirement. |
| 99 | + - [ ] Known good test content is created for unit testing. |
| 100 | + - [ ] Known bad test content is created for unit testing. |
| 101 | + - [ ] Unit testing is configured to run both known good and known bad test content examples. |
| 102 | + - [ ] Passing and failing unit tests, and corresponding test vectors in the form of known valid and invalid OSCAL test files, are created or updated for each constraint. |
| 103 | + - [ ] A Pull Request (PR) is submitted that fully addresses the goals section of the User Story in the issue. |
| 104 | + - [ ] This issue is referenced in the PR. |
| 105 | + validations: |
| 106 | + required: true |
| 107 | + |
| 108 | + - type: textarea |
| 109 | + attributes: |
| 110 | + label: Other information |
| 111 | + description: Provide any other relevant information. |
| 112 | + placeholder: | |
| 113 | + detailed explanation, suggestions how to fix, reference to related issues, links providing context, etc. |
| 114 | +
|
0 commit comments