From 0bba518c4d693472645adbf6bc8a647887db1c0b Mon Sep 17 00:00:00 2001 From: Christopher Bull <5499680+chrisb13@users.noreply.github.com> Date: Mon, 8 Sep 2025 12:04:29 +1000 Subject: [PATCH 1/5] Update contributing.rst making branch --- docs/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 67912d36..c5ab5f8d 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -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 ------------------------ From b950f8000602bdebcafebc37a81e5cdcf286c57f Mon Sep 17 00:00:00 2001 From: Christopher Bull <5499680+chrisb13@users.noreply.github.com> Date: Mon, 8 Sep 2025 12:32:16 +1000 Subject: [PATCH 2/5] Update contributing.rst following this discussion https://github.com/COSIMA/cosima-recipes/issues/610 --- docs/contributing.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index c5ab5f8d..f989cc01 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -142,7 +142,9 @@ of the notebook itself. Some tips for reviewing ^^^^^^^^^^^^^^^^^^^^^^^ - +* Does this PR close an issue? Does the author link to it or mention it? +* (Ideally) does the user use a branch name that identifies the user and the feature (e.g. `username/feature_name`) +* 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? From e1eb193ad398b77fabb74d7234eb88336d57cdf8 Mon Sep 17 00:00:00 2001 From: Christopher Bull <5499680+chrisb13@users.noreply.github.com> Date: Mon, 8 Sep 2025 12:43:04 +1000 Subject: [PATCH 3/5] template as discussed with Taimoor --- .github/pull_request_template.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..e70811ea --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1 @@ +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). From ab0f95a24108b5e184d0fc5264b93a024d4a2c0c Mon Sep 17 00:00:00 2001 From: Taimoor Sohail Date: Mon, 8 Sep 2025 13:10:55 +1000 Subject: [PATCH 4/5] Minor edits --- docs/contributing.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index f989cc01..54694bdd 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -140,11 +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? -* (Ideally) does the user use a branch name that identifies the user and the feature (e.g. `username/feature_name`) -* Has the author added their [affiliation details to this file](https://github.com/COSIMA/cosima-recipes/blob/main/.zenodo.json). +* (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? From fbe2cee878f04e2dd09706d5fb7174f17141a779 Mon Sep 17 00:00:00 2001 From: Christopher Bull <5499680+chrisb13@users.noreply.github.com> Date: Mon, 8 Sep 2025 14:37:42 +1000 Subject: [PATCH 5/5] Update pull_request_template.md Just adding the comment we discussed. --- .github/pull_request_template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e70811ea..331208c3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1 +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`!