Skip to content
Open
Changes from all commits
Commits
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
101 changes: 62 additions & 39 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# PR Summary

Sci/Tech Reviewer: <!-- SR id, filled by author when ready for review (e.g. @octocat) -->
**One-line Summary**

Sci/Tech Reviewer: <!-- SR id, filled by author when ready for review (e.g. @octocat) -->
Code Reviewer: <!-- CR id, filled by SSD/CCD (e.g. @octocat) -->

<!-- To be completed by the developer -->
Expand All @@ -20,72 +22,93 @@ Code Reviewer: <!-- CR id, filled by SSD/CCD (e.g. @octocat) -->
- is related to #issue-number
-->

## Code Quality Checklist
## :memo: Code Quality Checklist

- [ ] I have performed a self-review of my own code
- [ ] My code follows the project's [style guidelines](https://metoffice.github.io/lfric_core/how_to_contribute/index.html#how-to-contribute-index)
- [ ] Comments have been included that aid understanding and enhance the readability of the code
- [ ] My changes generate no new warnings
- [ ] All automated checks in the CI pipeline have completed successfully
- [ ] I have performed a self-review of my own code.
- [ ] My code follows the project's [style guidelines](https://metoffice.github.io/lfric_core/how_to_contribute/index.html#how-to-contribute-index).
- [ ] Comments have been included that aid understanding and enhance the readability of the code.
- [ ] My changes generate no new warnings.
- [ ] All automated checks in the CI pipeline have completed successfully.

## Testing
## :test_tube: Testing

- [ ] I have tested this change locally, using the LFRic Apps rose-stem suite
- [ ] If any tests fail (rose-stem or CI) the reason is understood and acceptable (e.g. kgo changes)
- [ ] I have added tests to cover new functionality as appropriate (e.g. system tests, unit tests, etc.)
- [ ] Any new tests have been assigned an appropriate amount of compute resource and have been allocated to an appropriate testing group (i.e. the developer tests are for jobs which use a small amount of compute resource and complete in a matter of minutes)
- [ ] I have tested this change locally, using the LFRic Apps rose-stem suite.
- [ ] If any tests fail (rose-stem or CI) the reason is understood and acceptable (e.g., KGO changes).
- [ ] I have added tests to cover new functionality as appropriate (e.g. system tests, unit tests, etc.).
- [ ] Any new tests have been assigned an appropriate amount of compute resource and have been allocated to an appropriate testing group (i.e., the developer tests are for jobs which use a small amount of compute resource and complete in a matter of minutes).

<!-- Describe other testing performed (if applicable) -->

### trac.log

<!-- Paste your trac.log from testing output here -->

## Security Considerations
## :shield: Security Considerations

- [ ] I have reviewed my changes for potential security issues.
- [ ] Sensitive data is properly handled (if applicable).
- [ ] Authentication and authorisation are properly implemented (if applicable).

## :zap: Performance Impact

- [ ] Performance of the code has been considered and, if applicable, suitable performance measurements have been conducted.

## :robot: Generative AI Declaration

**Did you use any Generative AI tools (e.g., GitHub Copilot, ChatGPT) to assist in writing, refactoring, or optimising code for this PR?**

- [ ] **No.** This code was written entirely manually.
- [ ] **Yes.** (If yes, please complete the verification items below).

- [ ] I have reviewed my changes for potential security issues
- [ ] Sensitive data is properly handled (if applicable)
- [ ] Authentication and authorisation are properly implemented (if applicable)
<details>
<summary><b>Click here to expand the AI Usage Verification Checklist</b></summary>

## Performance Impact
### AI Usage Verification

- [ ] Performance of the code has been considered and, if applicable, suitable performance measurements have been conducted
*Only check the boxes below if they are true. If any box cannot be checked, your PR will be automatically rejected.*

## AI Assistance and Attribution
- [ ] **Indemnified Tool:** The tool used is an approved, enterprise/institutional tier model that provides IPR indemnity (e.g., *Met Office GitHub Copilot Enterprise*).
- [ ] **No Free/Personal Tiers:** I confirm that **no** free or personal tier AI tools (which lack legal protection and IPR indemnity) were used.
- [ ] **In-File Attribution:** I have added the required `# Some of the content of this file...` comment block following the [Simulation Systems AI policy](https://metoffice.github.io/simulation-systems/FurtherDetails/ai.html).
- [ ] **Commit Attribution:** I have explicitly noted the tool's usage within my git commit messages.
- [ ] **Code Responsibility:** I have personally reviewed, tested, and understood all AI-assisted sections, and I take full responsibility for its logic, security, and IPR compliance.

- [ ] Some of the content of this change has been produced with the assistance of _Generative AI tool name_ (e.g., Met Office Github Copilot Enterprise, Github Copilot Personal, ChatGPT GPT-4, etc) and I have followed the [Simulation Systems AI policy](https://metoffice.github.io/simulation-systems/FurtherDetails/ai.html) (including attribution labels)
**Specific Tool(s) Used:**

<!-- If AI has been used, please provide more details here -->
*(e.g., Met Office GitHub Copilot Enterprise, [Institution Name] GitHub Copilot Enterprise, etc.)*
>
</details>

## Documentation
## :book: Documentation

- [ ] Where appropriate I have updated documentation related to this change and confirmed that it builds correctly
- [ ] Where appropriate I have updated documentation related to this change and confirmed that it builds correctly.

## PSyclone Approval
## :cyclone: PSyclone Approval

- [ ] If you have edited any PSyclone-related code (e.g. PSyKAl-lite, Kernel interface, optimisation scripts, LFRic data structure code) then please contact the [TCD Team](mailto:ToolsCollabDevTeam@metoffice.gov.uk)
- [ ] If you have edited any PSyclone-related code (e.g. PSyKAl-lite, Kernel interface, optimisation scripts, LFRic data structure code) then please contact the [TCD Team](mailto:ToolsCollabDevTeam@metoffice.gov.uk).

# Sci/Tech Review
## :microscope: Sci/Tech Review

<!-- To be completed by the Sci/Tech Reviewer -->
<!-- May be skipped for trivial tickets -->

- [ ] I understand this area of code and the changes being added
- [ ] The proposed changes correspond to the pull request description
- [ ] Documentation is sufficient (do documentation papers need updating)
- [ ] Sufficient testing has been completed
- [ ] I understand this area of code and the changes being added.
- [ ] The proposed changes correspond to the pull request description.
- [ ] Documentation is sufficient (do documentation papers need updating).
- [ ] Sufficient testing has been completed.

(_Please alert the code reviewer via a tag when you have approved the SR_)

# Code Review
## :computer: Code Review

<!-- To be completed by the Code Reviewer -->

- [ ] All dependencies have been resolved
- [ ] Related Issues have been properly linked and addressed
- [ ] CLA compliance has been confirmed
- [ ] Code quality standards have been met
- [ ] Tests are adequate and have passed
- [ ] Documentation is complete and accurate
- [ ] Security considerations have been addressed
- [ ] Performance impact is acceptable
- [ ] All dependencies have been resolved.
- [ ] Related Issues have been properly linked and addressed.
- [ ] CLA compliance has been confirmed.
- [ ] Code quality standards have been met.
- [ ] Tests are adequate and have passed.
- [ ] Documentation is complete and accurate.
- [ ] Security considerations have been addressed.
- [ ] Performance impact is acceptable.
- [ ] PR complies with the [Simulation Systems AI policy](https://metoffice.github.io/simulation-systems/FurtherDetails/ai.html).
Loading