Skip to content

Commit 9a15751

Browse files
lwasserarianesasso
andcommitted
Apply suggestions from code review
Co-authored-by: Ariane Sasso <[email protected]>
1 parent eedd3c6 commit 9a15751

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

software-peer-review-guide/reviewer-guide.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,14 @@ Some of the basic things that we look for in a review include:
2626
We like to have a mix of technical and usability focus in our reviews so it's ok if you don't have all of the above skills!
2727

2828
```{note}
29-
## New to package review? We offer mentorship
29+
## New to package review? We offer mentorship!
30+
``
3031
3132
If you are interested in peer review but have never reviewed before,
3233
we offer a mentorship program where we will pair you up with someone
3334
who has more experience reviewing code. From this experience you can
3435
learn more and empower yourself with code review skills. Software review skills
35-
are also generally in data science so they are skills worth investing in!
36+
are generally useful in data science, so they are skills worth investing in!
3637
```
3738

3839
## Get Started With Your Review
@@ -48,7 +49,7 @@ development/ editable mode `pip install -e .`
4849
```{important}
4950
Be sure
5051
that the version that you are reviewing aligns with the version
51-
submitted the version submitted by the author. The package version can
52+
submitted by the author. The package version can
5253
be found at the top of the review issue. In the example below you can
5354
see that `pyrolite` version 0.2.5
5455
was submitted for review.

software-peer-review-guide/where-to-find-python-package-reviewers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Try to balance your sense of the potential reviewer’s experience against the c
3232

3333
Each submission should be reviewed by _two_ package reviewers. Although it is
3434
fine for one of them to have less package development experience and more domain
35-
knowledge, the review should not be split into two parts. Both reviewers need to review
35+
knowledge, the review should not be split into two parts. Both reviewers need to review
3636
the package comprehensively, from their particular perspectives. In
3737
general, at least one reviewer should have prior reviewing experience, and of
3838
course inviting one new reviewer expands our pool of reviewers.

0 commit comments

Comments
 (0)