Skip to content

Commit 8d00ca5

Browse files
reviewer suggestions
1 parent fde0b63 commit 8d00ca5

8 files changed

Lines changed: 22 additions & 21 deletions

File tree

‎source/Development/TestSuites/multi-repo_testing.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Multi-Repository Testing
44
========================
55

66
Multi-repository changes are expected to pass the regression tests for all the
7-
repositories involved. To carry out the tests involved in a linked PR it can be
8-
helpful to refer to the :ref:`repository figure <multirepo>`; testing both child
9-
and parent repositories as needed. Further details of how testing in each
10-
repository is handled can be found on the :ref:`Testing page<testing>`.
7+
repositories involved. To carry out the tests involved in a linked pull request
8+
it can be helpful to refer to the :ref:`repository figure <multirepo>`; testing
9+
both child and parent repositories as needed. Further details of how testing in
10+
each repository is handled can be found on the :ref:`Testing page<testing>`.
1111

1212
All Simulation Systems repositories containing a test suite will also contain a
1313
``dependencies.yaml`` file in the top directory of the repository. This file

‎source/Development/TestSuites/ukca.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Testing UKCA
22
============
33

44
Changes in UKCA that touch `src/science` or `src/control/core` must be tested
5-
with both the UM and LFRic by following the :ref:`linked pull requests
5+
with both the UM and LFRic by following the :ref:`linked pull requests
66
guidance <multirepo>`.
77

88
For further guidance on testing and working with UKCA, including standard

‎source/Development/inputs.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ whether an upgrade macro is necessary.
102102
cd rose-meta
103103
rose edit -C ../rose-stem/app/APP-NAME --no-warn version
104104
105-
If you have a linked LFRic Core or Jules development with metadata changes,
106-
you can load their metadata by adding
105+
If you have a linked LFRic Core or Jules development with metadata changes,
106+
you can load their metadata by adding
107107
``-M /path/to/working_copy/rose-meta`` to the ``rose-edit`` command.
108108

109109

@@ -123,7 +123,7 @@ Adding a new metadata section requires:
123123
(see existing ones for examples)
124124

125125
The ``vnX.Y`` and ``HEAD`` metadata should be identical for this initial
126-
PR, other than any import statements, which should point at vnX.Y or HEAD
126+
change, other than any import statements, which should point at vnX.Y or HEAD
127127
respectively. Other ``vnX.Y`` and ``versionAB_CD.py`` files shouldn't be
128128
modified or added (these are a snapshot of the metadata at a release).
129129

‎source/Development/kgo.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ may also be required to simply add a new job to the test suite or to port the
1313
rose stem suite to new HPC architecture.
1414

1515
**LFRic** KGO checksums are stored in the repository. As such with LFRic
16-
pull requests the expectation is that you, as the developer, will include
16+
pull requests the expectation is that you, as the developer, will include
1717
updated KGO files as part of your branch.
1818

1919
**UM and JULES** KGO output files are stored outside of the repository. Access

‎source/Development/planning_your_change.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ aware of these.
6464

6565
**Who will SciTech review the change?** This is a useful consideration as not
6666
everyone who uses the repository has the knowledge or experience to review
67-
every PR that is being developed. Get in touch with your SciTech reviewer
67+
every change that is being developed. Get in touch with your SciTech reviewer
6868
early in the process as they will have valuable insights that can help to shape
6969
your change.
7070

‎source/FurtherDetails/dos_donts.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ sometimes years later.
1919
<docs>` and code comments. These help others and your future-self understand
2020
your work.
2121

22-
**Meaningful names** for issues, pull requests, branches and variables. These
22+
**Meaningful names** for issues, pull requests, branches and variables. These
2323
help others and your future-self understand your work. "My_Branch", "Fix" are
2424
not helpful.
2525

‎source/FurtherDetails/glossary.rst‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Code Review Deadline:
1414
moved into code review.
1515

1616
CodeSys Review:
17-
A technical review of the changes involved in the PR, including checks
18-
that code standards have been upheld and that the working practices have
19-
been followed. These reviews are generally completed by a member of the
17+
A technical review of the changes involved in the pull request, including
18+
checks that code standards have been upheld and that the working practices
19+
have been followed. These reviews are generally completed by a member of the
2020
Simulation IT Team. Once a review has been approved the Code Systems
2121
Reviewer is then responsible for committing the change to the trunk.
2222

@@ -37,13 +37,14 @@ Head of Trunk:
3737
since the last revision.
3838

3939
Linked Pull Request (Linked PR):
40-
Work that spans two or more repositories, requiring pull requests that
40+
Work that spans two or more repositories, requiring pull requests that
4141
should be treated together and committed as a group.
4242

4343
Overarching Issue:
4444
Where a piece of work has been split into multiple sections an overarching
4545
issue can be used to track this work. It should be closed when the whole arc
46-
has been completed.
46+
has been completed. GitHub also allows subissues which can be created from
47+
the overarching issue.
4748

4849
Regression:
4950
A set of tests that prove that a set of code changes have not degraded the

‎source/FurtherDetails/who.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@ of model evolution.
7979
Sci/Tech Reviewer
8080
-----------------
8181

82-
A Sci/Tech reviewer is assigned for every pull request and comprises the first
83-
stage of review that considers the change as a whole. Further details are found
84-
in the :ref:`Scitech Reviewers Guide<scitech_review>`. In some cases, the
82+
A Sci/Tech reviewer is assigned for every pull request and comprises the first
83+
stage of review that considers the change as a whole. Further details are found
84+
in the :ref:`Scitech Reviewers Guide<scitech_review>`. In some cases, the
8585
reviewer can delegate parts of the work to another person.
8686

8787
Reviews should be turned around on a reasonable timescale and follow the
@@ -96,8 +96,8 @@ most relevant code owner.
9696
Code Reviewer
9797
-------------
9898

99-
The Code Reviewer performs the 2nd stage of review for every pull
100-
request. Further details are described in the :ref:`Code Reviewers
99+
The Code Reviewer performs the 2nd stage of review for every pull
100+
request. Further details are described in the :ref:`Code Reviewers
101101
Guide<code_review>`.
102102

103103
Reviews should be turned around on a reasonable timescale and follow the Code

0 commit comments

Comments
 (0)