Skip to content

Commit

Permalink
Updating PR template, doc links to PR info (#324)
Browse files Browse the repository at this point in the history
* modifying PR template

* updating PR template

* adding link to documentation for PR (#1)

* modifying PR template

* typo

* modifying wording

* modifying link per PBsuggestion

* adding second link

* adding Tony's changes

* typo

* Making ECH suggestions
  • Loading branch information
duvivier authored Jun 18, 2019
1 parent 03bc8cb commit efdb29b
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 18 deletions.
46 changes: 28 additions & 18 deletions .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
@@ -1,19 +1,29 @@
[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)

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:
For detailed information about submitting Pull Requests (PRs) to the CICE-Consortium,
please refer to: <https://github.com/CICE-Consortium/About-Us/wiki/Resource-Index#information-for-developers>


## 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.
- [ ] Please copy the PR test results link or provide a summary of testing completed below.
ENTER INFORMATION HERE
- How much do the PR code changes differ from the unmodified code?
- [ ] 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 any new test cases?
- [ ] Yes
- [ ] No
- 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, does the documentation need to be updated at a later time?
- [ ] Yes
- [ ] No
- [ ] Please provide any additional information or relevant details below:
11 changes: 11 additions & 0 deletions doc/source/developer_guide/dg_about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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#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

0 comments on commit efdb29b

Please sign in to comment.