Part nasa/cFS#1079, Adding specialty PR templates and links to the specialty PR templates in the default PR template. #183
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,51 @@ | ||
| --- | ||
| name: Comment / Documentation Change | ||
| about: Changes limited to comments, README, docstrings, or other documentation | ||
| labels: documentation | ||
| --- | ||
|
|
||
| ## Description of Change | ||
|
|
||
| <!-- Briefly describe what documentation/comments were changed and why. --> | ||
|
|
||
| ## Linked Issue | ||
|
|
||
| <!-- Required. Reference the GitHub issue this PR addresses, e.g., Closes #123 --> | ||
| Closes # | ||
|
|
||
| ## Areas of Expertise Touched | ||
|
|
||
| <!-- Check all that apply so the appropriate Experts can be tagged as reviewers. --> | ||
| <!-- See the expertise tags in the "cFS Dev Team" Teams channel or ask your team lead to help identify experts. --> | ||
| - [ ] ASTRO | ||
| - [ ] CI/CD | ||
| - [ ] COSMOS | ||
| - [ ] Cybersecurity | ||
| - [ ] Docker | ||
| - [ ] EDS | ||
| - [ ] Git | ||
| - [ ] PSPs | ||
| - [ ] SBN | ||
| - [ ] SMP | ||
| - [ ] Tables | ||
| - [ ] TSN | ||
| - [ ] Unit Tests | ||
| - [ ] Other | ||
|
|
||
| --- | ||
|
|
||
| ## Author Checklist | ||
|
There was a problem hiding this comment. Can we add something like "Commit history squashed"
Collaborator
Author
There was a problem hiding this comment. Discussed at 8/3/2026 stand up and team decided to place commit squashing guidance in a central "Pull Request Guide," as the commit history should/should not be squashed depending on the circumstances. This is being tracked in nasa/cFE#2788 and the PR templates will be updated accordingly once that guide has been created. |
||
|
|
||
| - [ ] Linked GitHub issue is referenced above/linked to this PR | ||
| - [ ] Documentation generation workflow ran successfully on this branch | ||
| - [ ] Changes are limited to documentation/comments (no code behavior changes) | ||
|
|
||
| --- | ||
|
|
||
| ## Reviewer Checklist | ||
|
|
||
| - [ ] Documentation is clear, accurate, and complete | ||
| - [ ] Spelling and grammar reviewed | ||
| - [ ] Any links in the documentation have been verified to work | ||
| - [ ] Documentation generation workflow output looks correct | ||
| - [ ] Appropriate Expert areas have been reviewed | ||
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,89 @@ | ||
| --- | ||
| name: FSW Code Change | ||
| about: Flight Software code changes | ||
| labels: fsw | ||
| --- | ||
|
|
||
| ## Description of Change | ||
|
|
||
| <!-- Describe what was changed, why, and how. Include any design notes that will help reviewers. --> | ||
|
|
||
| ## Linked Issue | ||
|
|
||
| Closes # | ||
|
|
||
| ## Requirements Impact | ||
|
|
||
| <!-- List any requirements impacted by this change. Indicate whether each was updated, or confirm the change continues to satisfy existing requirements. --> | ||
| - Requirement ID(s): | ||
|
There was a problem hiding this comment. A link to the requirements would be helpful |
||
| - [ ] Requirements updated as necessary | ||
| - [ ] Existing requirements are still satisfied by this change | ||
|
|
||
| ## Testing Evidence | ||
|
|
||
| <!-- Paste relevant test output, link to CI runs, or attach screenshots. --> | ||
|
|
||
| ### Unit Tests (UT Assert) | ||
| <!-- Link to CI run or paste summary --> | ||
|
|
||
| ### COSMOS Test Suite | ||
| <!-- Link to CI run, paste summary, or note "N/A — no relevant changes" --> | ||
|
|
||
| ## Areas of Expertise Touched | ||
|
There was a problem hiding this comment. A link to the expertise Excel file would be helpful for determining who to contact |
||
|
|
||
| <!-- Check all that apply so the appropriate Experts can be tagged as reviewers. --> | ||
| <!-- See the expertise tags in the "cFS Dev Team" Teams channel or ask your team lead to help identify experts. --> | ||
| - [ ] ASTRO | ||
| - [ ] CI/CD | ||
| - [ ] COSMOS | ||
| - [ ] Cybersecurity | ||
| - [ ] Docker | ||
| - [ ] EDS | ||
| - [ ] Git | ||
| - [ ] PSPs | ||
| - [ ] SBN | ||
| - [ ] SMP | ||
| - [ ] Tables | ||
| - [ ] TSN | ||
| - [ ] Unit Tests | ||
| - [ ] Other | ||
|
|
||
| --- | ||
|
|
||
| ## Author Checklist | ||
|
There was a problem hiding this comment. Can we add something like "Commit history squashed"
Collaborator
Author
There was a problem hiding this comment. Discussed at 8/3/2026 stand up and team decided to place commit squashing guidance in a central "Pull Request Guide," as the commit history should/should not be squashed depending on the circumstances. This is being tracked in nasa/cFE#2788 and the PR templates will be updated accordingly once that guide has been created. |
||
|
|
||
| - [ ] Linked GitHub issue is referenced above | ||
| - [ ] Code has been formatted with `.clang-format` | ||
| - [ ] Static analysis workflows ran and passed | ||
| - [ ] Unit tests (UT Assert) updated/added to cover code changes | ||
| - [ ] Unit test workflows ran and passed | ||
| - [ ] COSMOS test suite was run; tests updated/added if relevant changes were made | ||
| - [ ] Requirements have been reviewed; updated or confirmed still satisfied (see above) | ||
| - [ ] Testing evidence is included above | ||
| - [ ] Self-review of the diff completed | ||
|
|
||
| --- | ||
|
|
||
| ## Reviewer Checklist | ||
|
|
||
| - [ ] Code logic is correct and matches the stated intent | ||
| - [ ] Code is readable, maintainable, and follows project conventions (ask your lead if you are unsure of where to find these conventions) | ||
| - [ ] `.clang-format` has been applied | ||
| - [ ] Static analysis results reviewed and acceptable | ||
| - [ ] **The change has been exercised by the unit tests** (not just that tests pass — the new/changed code paths are actually covered) | ||
| - [ ] **COSMOS test suite was executed against this change** and results reviewed (or confirmed N/A with justification) | ||
| - [ ] **Reviewer has independently verified the change behaves as described** (e.g., by running the tests locally, reviewing CI output in detail, or performing additional ad-hoc testing as warranted) | ||
| - [ ] **Memory safety** reviewed (allocation, bounds, lifetime, stack usage) | ||
| - [ ] Requirements impact reviewed and appropriate | ||
| - [ ] Error handling is appropriate | ||
| - [ ] Appropriate Expert areas have been reviewed | ||
|
|
||
| ### Reviewer Testing Notes | ||
|
|
||
| <!-- | ||
| Describe how you independently verified this change. For example: | ||
| - "Pulled the branch locally, ran `make test`, all UT Assert tests passed including the new ones for X." | ||
| - "Ran the COSMOS test suite against the branch; observed expected telemetry behavior for Y." | ||
| - "Reviewed CI run #1234; verified the new code paths are covered by inspecting the coverage report." | ||
| - "Performed ad-hoc test by [describe scenario]; observed [result]." | ||
| --> | ||
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,52 @@ | ||
| --- | ||
| name: Workflows Change | ||
| about: Changes to files under .github/workflows/ | ||
| labels: ci/workflows | ||
| --- | ||
|
|
||
| ## Description of Change | ||
|
|
||
| <!-- Describe what workflow(s) were changed and why. --> | ||
|
|
||
| ## Linked Issue | ||
|
|
||
| Closes # | ||
|
|
||
| ## Areas of Expertise Touched | ||
|
There was a problem hiding this comment. A link to the expertise Excel file would be helpful for determining who to contact |
||
|
|
||
| <!-- Check all that apply so the appropriate Experts can be tagged as reviewers. --> | ||
| <!-- See the expertise tags in the "cFS Dev Team" Teams channel or ask your team lead to help identify experts. --> | ||
| - [ ] ASTRO | ||
| - [ ] CI/CD | ||
| - [ ] COSMOS | ||
| - [ ] Cybersecurity | ||
| - [ ] Docker | ||
| - [ ] EDS | ||
| - [ ] Git | ||
| - [ ] PSPs | ||
| - [ ] SBN | ||
| - [ ] SMP | ||
| - [ ] Tables | ||
| - [ ] TSN | ||
| - [ ] Unit Tests | ||
| - [ ] Other | ||
|
|
||
| --- | ||
|
|
||
| ## Author Checklist | ||
|
There was a problem hiding this comment. Can we add something like "Commit history squashed"
Collaborator
Author
There was a problem hiding this comment. Discussed at 8/3/2026 stand up and team decided to place commit squashing guidance in a central "Pull Request Guide," as the commit history should/should not be squashed depending on the circumstances. This is being tracked in nasa/cFE#2788 and the PR templates will be updated accordingly once that guide has been created. |
||
|
|
||
| - [ ] Linked GitHub issue is referenced above | ||
| - [ ] Workflow changes were tested on a branch/fork before submitting this PR | ||
| - [ ] All workflows ran successfully on this branch | ||
|
|
||
| --- | ||
|
|
||
| ## Reviewer Checklist | ||
|
|
||
| - [ ] Workflow logic is correct and achieves the stated goal | ||
| - [ ] Third-party actions are from trusted sources and pinned to a specific SHA/tag | ||
| - [ ] Secrets are handled appropriately (no secrets exposed in logs, least-privilege usage) | ||
| - [ ] Workflow permissions follow the principle of least privilege | ||
| - [ ] Changes do not break or bypass existing branch protection rules | ||
| - [ ] All workflow runs on this PR completed successfully | ||
| - [ ] Appropriate Expert areas have been reviewed | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A link to the expertise Excel file would be helpful for determining who to contact