diff --git a/source/FurtherDetails/who.rst b/source/FurtherDetails/who.rst index b538481e..0a657201 100644 --- a/source/FurtherDetails/who.rst +++ b/source/FurtherDetails/who.rst @@ -80,8 +80,8 @@ Sci/Tech Reviewer ----------------- A Sci/Tech reviewer is assigned for every ticket and comprises the first stage -of review that considers the change as a whole. Further details are linked -from the :ref:`Working Practices page`. In some cases, the reviewer +of review that considers the change as a whole. Further details are found in +the :ref:`Scitech Reviewers Guide`. In some cases, the reviewer can delegate parts of the work to another person. Reviews should be turned around on a reasonable timescale and follow the @@ -97,7 +97,7 @@ Code Reviewer ------------- The Code Reviewer performs the 2nd stage of review for every ticket. Further -details are described :ref:`Working Practices page`. +details are described in the :ref:`Code Reviewers Guide`. Reviews should be turned around on a reasonable timescale and follow the Code Review guidance. diff --git a/source/Reviewers/codereview.rst b/source/Reviewers/codereview.rst index 43d2ee47..9fdcc6d6 100644 --- a/source/Reviewers/codereview.rst +++ b/source/Reviewers/codereview.rst @@ -3,6 +3,13 @@ Code and System Review ====================== +.. tip:: + + GitHub documentation on the review process and interface: + `Reviewing Proposed Changes in a Pull Request `_ + Purpose of the review --------------------- The purpose of the code/system review is to analyse a change for its impact and @@ -16,16 +23,17 @@ and should question anything that is poorly coded. Reviewer responsibilities and checkpoints ----------------------------------------- -The Code/System review template exists to help you think through all the areas -of concern. A completed :ref:`review template