Skip to content

Part #1079, Adding specialty PR templates and links to the specialty PR templates in the default PR template. #1080

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.

Sign up for GitHub

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

Open
dzbaker wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Part #1079, Adding specialty PR templates and links to the specialty PR templates in the default PR template. #1080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/comment_documentation_change.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
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. -->
- [ ] ASTRO
- [ ] CI/CD
- [ ] COSMOS
- [ ] Cybersecurity
- [ ] Docker
- [ ] EDS
- [ ] Git
- [ ] PSPs
- [ ] SBN
- [ ] SMP
- [ ] Tables
- [ ] TSN
- [ ] Unit Tests
- [ ] Other

---

## Author Checklist

- [ ] 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
88 changes: 88 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/fsw_code_change.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
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):
- [ ] 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

- [ ] ASTRO
- [ ] CI/CD
- [ ] COSMOS
- [ ] Cybersecurity
- [ ] Docker
- [ ] EDS
- [ ] Git
- [ ] PSPs
- [ ] SBN
- [ ] SMP
- [ ] Tables
- [ ] TSN
- [ ] Unit Tests
- [ ] Other

---

## Author Checklist

- [ ] 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
- [ ] `.clang-format` has been applied
- [ ] Static analysis results reviewed and acceptable
- [ ] Unit tests are meaningful and adequately cover the changes
- [ ] **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]."
-->
67 changes: 67 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/tools_code_change.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
name: Tools Repository Change
about: Changes to ground-side tools
labels: tools
---

## Description of Change

<!-- Describe what was changed and why. -->

## Linked Issue

Closes #

## Testing Evidence

<!-- Paste relevant test output, link to CI runs, or attach screenshots demonstrating the tool works as intended. -->

## Areas of Expertise Touched

- [ ] ASTRO
- [ ] CI/CD
- [ ] COSMOS
- [ ] Cybersecurity
- [ ] Docker
- [ ] EDS
- [ ] Git
- [ ] PSPs
- [ ] SBN
- [ ] SMP
- [ ] Tables
- [ ] TSN
- [ ] Unit Tests
- [ ] Other

---

## Author Checklist

- [ ] Linked GitHub issue is referenced above
- [ ] Tool has been tested locally and works as intended
- [ ] Tests updated/added to cover the changes
- [ ] All CI workflows ran and passed
- [ ] 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
- [ ] Tests are meaningful and adequately cover the changes
- [ ] Testing evidence reviewed and acceptable
- [ ] **The change has been exercised by the tests** (not just that tests pass — the new/changed code paths are actually covered)
- [ ] **Reviewer has independently verified the change behaves as described** (e.g., by running the tool locally, reviewing CI output in detail, or performing additional ad-hoc testing as warranted)
- [ ] 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 the tool against [test input], output matched expectations."
- "Reviewed CI run #1234; verified the new code paths are covered."
- "Performed ad-hoc test by [describe scenario]; observed [result]."
-->
50 changes: 50 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/workflows_change.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
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

- [ ] ASTRO
- [ ] CI/CD
- [ ] COSMOS
- [ ] Cybersecurity
- [ ] Docker
- [ ] EDS
- [ ] Git
- [ ] PSPs
- [ ] SBN
- [ ] SMP
- [ ] Tables
- [ ] TSN
- [ ] Unit Tests
- [ ] Other

---

## Author Checklist

- [ ] 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
6 changes: 6 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,9 @@ The cFS repository is provided to bundle the cFS Framework. It is utilized for
**Contributor Info - All information REQUIRED for consideration of pull request**
Full name and company/organization/center of all contributors ("Personal" if individual work)
- Note CLAs apply to only software contributions.

**For members of the cFS Team**
Click the `Preview` tab and select the pull request template corresponding to the type of change you are submitting:
- [Comment/Documentation Change](?expand=1&template=comment_documentation_change.md)
- [Flight Software Code Change](?expand=1&template=fsw_code_change.md)
- [Workflows Change](?expand=1&template=workflows_change.md)
Loading