Updated guidance on how to review pull requests #610
Description
Following from the PR review discussion at the COSIMA hackathon v5 (thanks @navidcy @taimoorsohail!).
Ideas:
- popular idea:
- keep it really simple and unimposing, i.e.i, add a link to this in a PR template: https://cosima-recipes.readthedocs.io/en/latest/contributing.html#reviewing-existing-pull-requests
----- Here's a PR template that I hacked up, for some inspiration (perhaps convert existing instructions to be more tick listy)
Description
Describe the changes made in this pull request and their purpose.
Related Issue(s)
Link or list any related issues or tasks that this pull request addresses.
e.g., Closes #123, Resolves #456
Type of Change
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Documentation update
How Has This Been Tested?
Describe the testing you performed to ensure the changes work as expected. Include details on your test environment and any specific steps or commands used.
Checklist
- Does the PR have a concise description?
- Does this PR close an issue? Link to or mention it.
- (Ideally) use a branch name that identifies the user and the feature (e.g. username/feature_name)
- Have you added your authorship details to this file?