From 55000aca7c7b138ebdcd3ebed3014f8bc25683f5 Mon Sep 17 00:00:00 2001 From: Alice DuVivier Date: Fri, 14 Jun 2019 10:52:10 -0600 Subject: [PATCH 01/11] modifying PR template --- .github/PULL_REQUEST_TEMPLATE | 45 +++++++++++++++++++++++++---------- 1 file changed, 32 insertions(+), 13 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 83509033c..176dccd9a 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -1,19 +1,38 @@ [Remove this and add a short summary line]: -- Developer(s): - -- Please suggest code Pull Request reviewers in the column at right. - -- Are the code changes bit for bit, different at roundoff level, or more substantial? - -- Please include the link to test results or paste the summary block from the bottom of the testing output below. - -- Does this PR create or have dependencies on Icepack or any other models? - -- Is the documentation being updated with this PR? (Y/N) -If not, does the documentation need to be updated separately at a later time? (Y/N) +Please refer to our Information for Developers documentation for questions on submitting a +Pull Request (hereafter PR): + +## PR checklist + +Please check the following boxes to be sure your PR fullfills our requirements: +- [ ] Developer(s): +- [ ] Suggest PR reviewers from list in the column to the right + + +## Details about PR code +- [ ] Are the PR code changes + - [ ] bit for bit + - [ ] different at roundoff level + - [ ] more substantial +- [ ] Does this PR create or have dependencies on Icepack or any other models? + - [ ] Yes + - [ ] No +- [ ] Does this PR add a code test option? + - [ ] Yes + - [ ] No +- [ ] Include the link to test results or paste a summary block from the bottom of the testing output: + ENTER TEST INFORMATION HERE + +## Details about PR documentation +- [ ] Is the documentation being updated? + - [ ] Yes + - [ ] No +- [ ] If not, does the documentation need to be updated separately at a later time? + - [ ] Yes + - [ ] No Note: "Documentation" includes information on the wiki and .rst files in doc/source/, which are used to create the online technical docs at https://readthedocs.org/projects/cice-consortium-cice/. -- Other Relevant Details: +## Enter any other relevant details below: From 418c7cd43f13feb44fb8f15edcc748092e542043 Mon Sep 17 00:00:00 2001 From: Alice DuVivier Date: Fri, 14 Jun 2019 10:55:14 -0600 Subject: [PATCH 02/11] updating PR template --- .github/PULL_REQUEST_TEMPLATE | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 176dccd9a..065c74a21 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -3,13 +3,16 @@ Please refer to our Information for Developers documentation for questions on submitting a Pull Request (hereafter PR): -## PR checklist - +# PR checklist Please check the following boxes to be sure your PR fullfills our requirements: + +## Basic PR Information - [ ] Developer(s): + JANE DOE +- [ ] Short (1 sentence) summary of your PR: + ENTER INFORMATION HERE - [ ] Suggest PR reviewers from list in the column to the right - ## Details about PR code - [ ] Are the PR code changes - [ ] bit for bit @@ -22,7 +25,7 @@ Please check the following boxes to be sure your PR fullfills our requirements: - [ ] Yes - [ ] No - [ ] Include the link to test results or paste a summary block from the bottom of the testing output: - ENTER TEST INFORMATION HERE + ENTER TEST INFORMATION HERE ## Details about PR documentation - [ ] Is the documentation being updated? From 44f6ad5ea50dbea3bad76fde61d603535cb1372c Mon Sep 17 00:00:00 2001 From: Alice DuVivier Date: Fri, 14 Jun 2019 11:13:19 -0600 Subject: [PATCH 03/11] adding link to documentation for PR (#1) --- doc/source/developer_guide/dg_about.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/source/developer_guide/dg_about.rst b/doc/source/developer_guide/dg_about.rst index 0fae7db05..e8cb60d14 100755 --- a/doc/source/developer_guide/dg_about.rst +++ b/doc/source/developer_guide/dg_about.rst @@ -16,3 +16,14 @@ Guiding principles for the creation of CICE include the following: on individual gridcells, and contain no underlying infrastructure. CICE must call into Icepack using interfaces and approaches specified by Icepack. + +Git workflow and Pull Requests +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +There is extensive Information for Developers documentation available. +See https://github.com/CICE-Consortium/About-Us/wiki/Resource-Index +for information on: + - Contributing to model development + - Software development practices guide + - git Workflow Guide - including extensive information about the Pull Request process and requirements + - Documentation Workflow Guide \ No newline at end of file From 8bff91d88b5a18c1a3370519b349184db13232b3 Mon Sep 17 00:00:00 2001 From: Alice DuVivier Date: Fri, 14 Jun 2019 11:16:23 -0600 Subject: [PATCH 04/11] modifying PR template --- .github/PULL_REQUEST_TEMPLATE | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 065c74a21..635ddb480 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -1,5 +1,3 @@ -[Remove this and add a short summary line]: - Please refer to our Information for Developers documentation for questions on submitting a Pull Request (hereafter PR): From a7d8a4a83e13318f390d7d06b8839f9432e097da Mon Sep 17 00:00:00 2001 From: Alice DuVivier Date: Fri, 14 Jun 2019 11:19:03 -0600 Subject: [PATCH 05/11] typo --- .github/PULL_REQUEST_TEMPLATE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 635ddb480..4543ad20e 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -2,7 +2,7 @@ Please refer to our Information for Developers documentation for questions on su Pull Request (hereafter PR): # PR checklist -Please check the following boxes to be sure your PR fullfills our requirements: +Please check the following boxes to be sure your PR fulfills our requirements: ## Basic PR Information - [ ] Developer(s): From 5916b85d7b2174cc01e659e0588ef43e22dfc328 Mon Sep 17 00:00:00 2001 From: Alice DuVivier Date: Fri, 14 Jun 2019 11:25:14 -0600 Subject: [PATCH 06/11] modifying wording --- .github/PULL_REQUEST_TEMPLATE | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 4543ad20e..c6947a44d 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -1,8 +1,7 @@ +# PR checklist Please refer to our Information for Developers documentation for questions on submitting a Pull Request (hereafter PR): - -# PR checklist -Please check the following boxes to be sure your PR fulfills our requirements: +Then, please check the following boxes as you verify that your PR fulfills our requirements. ## Basic PR Information - [ ] Developer(s): From ad283b14dab92b4efd191cdac20594f7a8467e65 Mon Sep 17 00:00:00 2001 From: Alice DuVivier Date: Fri, 14 Jun 2019 11:33:24 -0600 Subject: [PATCH 07/11] modifying link per PBsuggestion --- .github/PULL_REQUEST_TEMPLATE | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index c6947a44d..49b9b6e98 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -1,6 +1,7 @@ -# PR checklist -Please refer to our Information for Developers documentation for questions on submitting a -Pull Request (hereafter PR): +## PR checklist +Please refer to our documentation for questions about submitting a Pull Request +(hereafter PR): + Then, please check the following boxes as you verify that your PR fulfills our requirements. ## Basic PR Information From 966d644a117595070e3d5a54b63e5f13fa2fa986 Mon Sep 17 00:00:00 2001 From: Alice DuVivier Date: Fri, 14 Jun 2019 11:35:36 -0600 Subject: [PATCH 08/11] adding second link --- doc/source/developer_guide/dg_about.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/developer_guide/dg_about.rst b/doc/source/developer_guide/dg_about.rst index e8cb60d14..bd06d7a3f 100755 --- a/doc/source/developer_guide/dg_about.rst +++ b/doc/source/developer_guide/dg_about.rst @@ -21,9 +21,9 @@ Git workflow and Pull Requests ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ There is extensive Information for Developers documentation available. -See https://github.com/CICE-Consortium/About-Us/wiki/Resource-Index +See https://github.com/CICE-Consortium/About-Us/wiki/Resource-Index#information-for-developers for information on: - Contributing to model development - Software development practices guide - git Workflow Guide - including extensive information about the Pull Request process and requirements - - Documentation Workflow Guide \ No newline at end of file + - Documentation Workflow Guide From 0d7bc50db0d764ccaff1bb44e64d28fbd49ba112 Mon Sep 17 00:00:00 2001 From: Alice DuVivier Date: Fri, 14 Jun 2019 13:35:28 -0600 Subject: [PATCH 09/11] adding Tony's changes --- .github/PULL_REQUEST_TEMPLATE | 38 +++++++++++++---------------------- 1 file changed, 14 insertions(+), 24 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 49b9b6e98..59452fa24 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -1,39 +1,29 @@ -## PR checklist -Please refer to our documentation for questions about submitting a Pull Request -(hereafter PR): -Then, please check the following boxes as you verify that your PR fulfills our requirements. +For details information about submitting Pull Requests (PRs) to the CICE-Consortium, +please refer to: -## Basic PR Information -- [ ] Developer(s): - JANE DOE + +## PR checklist - [ ] Short (1 sentence) summary of your PR: ENTER INFORMATION HERE +- [ ] Developer(s): + ENTER INFORMATION HERE - [ ] Suggest PR reviewers from list in the column to the right - -## Details about PR code - [ ] Are the PR code changes - [ ] bit for bit - [ ] different at roundoff level - [ ] more substantial +- [ ] Include a link to test results or provide a summary of testing completed + ENTER INFORMATION HERE - [ ] Does this PR create or have dependencies on Icepack or any other models? - [ ] Yes - [ ] No -- [ ] Does this PR add a code test option? +- [ ] Does this PR add any new test cases? - [ ] Yes - [ ] No -- [ ] Include the link to test results or paste a summary block from the bottom of the testing output: - ENTER TEST INFORMATION HERE - -## Details about PR documentation -- [ ] Is the documentation being updated? - - [ ] Yes - - [ ] No -- [ ] If not, does the documentation need to be updated separately at a later time? +- [ ] Is the documentation being updated? ("Documentation" includes information on the wiki or in the .rst files from doc/source/, which are used to create the online technical docs at https://readthedocs.org/projects/cice-consortium-cice/.) - [ ] Yes - - [ ] No - -Note: "Documentation" includes information on the wiki and .rst files in doc/source/, -which are used to create the online technical docs at https://readthedocs.org/projects/cice-consortium-cice/. - -## Enter any other relevant details below: + - [ ] No, does the documentation need to be updated at a later time? + - [ ] Yes + - [ ] No +- [ ] Please provide any additional information or relevant details below: From c3e81f848ba7a3fe49153774aecd44f84b2aaf5f Mon Sep 17 00:00:00 2001 From: Alice DuVivier Date: Fri, 14 Jun 2019 15:14:24 -0600 Subject: [PATCH 10/11] typo --- .github/PULL_REQUEST_TEMPLATE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 59452fa24..0d1637b72 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -1,5 +1,5 @@ -For details information about submitting Pull Requests (PRs) to the CICE-Consortium, +For detailed information about submitting Pull Requests (PRs) to the CICE-Consortium, please refer to: From 5fab2fe4b14a9aab45b1432bd9fffcc8b06c85cc Mon Sep 17 00:00:00 2001 From: Alice DuVivier Date: Sat, 15 Jun 2019 23:39:19 -0600 Subject: [PATCH 11/11] Making ECH suggestions --- .github/PULL_REQUEST_TEMPLATE | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 0d1637b72..5195feed8 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -8,20 +8,20 @@ please refer to: