From e65bb7cd5574d75bdb59001fe725a01ec2c208ea Mon Sep 17 00:00:00 2001 From: Dylan Baker Date: Mon, 3 Aug 2026 19:52:50 +0000 Subject: [PATCH] Part nasa/cFS#1079, adding further guidance to the pull request templates. --- .../comment_documentation_change.md | 1 + .../PULL_REQUEST_TEMPLATE/fsw_code_change.md | 89 +++++++++++++++++++ .../tools_code_change.md | 67 -------------- .../PULL_REQUEST_TEMPLATE/workflows_change.md | 2 + .github/pull_request_template.md | 12 +-- 5 files changed, 98 insertions(+), 73 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/fsw_code_change.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/tools_code_change.md diff --git a/.github/PULL_REQUEST_TEMPLATE/comment_documentation_change.md b/.github/PULL_REQUEST_TEMPLATE/comment_documentation_change.md index 4c5537c..de1252a 100644 --- a/.github/PULL_REQUEST_TEMPLATE/comment_documentation_change.md +++ b/.github/PULL_REQUEST_TEMPLATE/comment_documentation_change.md @@ -16,6 +16,7 @@ Closes # ## Areas of Expertise Touched + - [ ] ASTRO - [ ] CI/CD - [ ] COSMOS diff --git a/.github/PULL_REQUEST_TEMPLATE/fsw_code_change.md b/.github/PULL_REQUEST_TEMPLATE/fsw_code_change.md new file mode 100644 index 0000000..2a8f865 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/fsw_code_change.md @@ -0,0 +1,89 @@ +--- +name: FSW Code Change +about: Flight Software code changes +labels: fsw +--- + +## Description of Change + + + +## Linked Issue + +Closes # + +## Requirements Impact + + +- Requirement ID(s): +- [ ] Requirements updated as necessary +- [ ] Existing requirements are still satisfied by this change + +## Testing Evidence + + + +### Unit Tests (UT Assert) + + +### COSMOS Test Suite + + +## 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 (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 + + \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/tools_code_change.md b/.github/PULL_REQUEST_TEMPLATE/tools_code_change.md deleted file mode 100644 index 00d2f1b..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/tools_code_change.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -name: Tools Repository Change -about: Changes to ground-side tools -labels: tools ---- - -## Description of Change - - - -## Linked Issue - -Closes # - -## Testing Evidence - - - -## 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 - - \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/workflows_change.md b/.github/PULL_REQUEST_TEMPLATE/workflows_change.md index 8fe91cb..700e398 100644 --- a/.github/PULL_REQUEST_TEMPLATE/workflows_change.md +++ b/.github/PULL_REQUEST_TEMPLATE/workflows_change.md @@ -14,6 +14,8 @@ Closes # ## Areas of Expertise Touched + + - [ ] ASTRO - [ ] CI/CD - [ ] COSMOS diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 44c7301..ba9a26e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,3 +1,9 @@ +**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) + **Describe the contribution** A clear and concise description of what the contribution is. - Include explicitly what issue it addresses [e.g. Fixes #X] @@ -27,9 +33,3 @@ If included, identify any third party code and provide text file of license **Contributor Info - All information REQUIRED for consideration of pull request** Full name and company/organization/center of all contributors ("Personal" if individual work) - Note CLA's apply to 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) -- [Tools Code Change](?expand=1&template=tools_code_change.md) -- [Workflows Change](?expand=1&template=workflows_change.md)