Skip to content

Updated guidance on how to be acknowledged on a Pull Request #611

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

Merged
merged 6 commits into from
Sep 8, 2025
Merged

Updated guidance on how to be acknowledged on a Pull Request #611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0bba518
Update contributing.rst
chrisb13 Sep 8, 2025
b950f80
Update contributing.rst
chrisb13 Sep 8, 2025
6f01156
Merge branch 'main' into cbull/472+610_PRdocs
taimoorsohail Sep 8, 2025
e1eb193
template as discussed with Taimoor
chrisb13 Sep 8, 2025
ab0f95a
Minor edits
taimoorsohail Sep 8, 2025
fbe2cee
Update pull_request_template.md
chrisb13 Sep 8, 2025
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
3 changes: 3 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
For tips on creating and reviewing pull requests, see `Some tips for reviewing` on the [documentation here](https://cosima-recipes.readthedocs.io/en/latest/contributing.html).

Upon merge, you will be a contributor, so don't forget to [add your details](https://github.com/COSIMA/cosima-recipes/blob/main/.zenodo.json) to the `.zenodo.json`!
9 changes: 6 additions & 3 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Recipes
.. _cf-xarray: https://cf-xarray.readthedocs.io/en/latest/
.. _pint: https://pint.readthedocs.io/en/stable/


Getting started with git
------------------------

Expand Down Expand Up @@ -140,9 +140,12 @@ Instead, the *review-notebook-app* bot will leave a comment with a **ReviewNB**
button on every pull request: this lets you leave your feedback on a representation
of the notebook itself.

Some tips for reviewing
^^^^^^^^^^^^^^^^^^^^^^^
Some tips for writing a PR or reviewing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* Does this PR close an issue? Does the author link to it or mention it?
* (Optional) does the user use a branch name that identifies the user and the feature (e.g. `username/feature_name`)
* (Optional) Has the author added their [affiliation details to this file](https://github.com/COSIMA/cosima-recipes/blob/main/.zenodo.json).
* Does the pull request have a concise description of the proposed changes? If not, request it.
* Have a look at the proposed changes. Do they make sense?
* Is the proposed code clean and clear?
Expand Down