File tree 2 files changed +5
-4
lines changed
software-peer-review-guide
2 files changed +5
-4
lines changed Original file line number Diff line number Diff line change @@ -26,13 +26,14 @@ Some of the basic things that we look for in a review include:
26
26
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!
27
27
28
28
``` {note}
29
- ## New to package review? We offer mentorship
29
+ ## New to package review? We offer mentorship!
30
+ ``
30
31
31
32
If you are interested in peer review but have never reviewed before,
32
33
we offer a mentorship program where we will pair you up with someone
33
34
who has more experience reviewing code. From this experience you can
34
35
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!
36
37
```
37
38
38
39
## Get Started With Your Review
@@ -48,7 +49,7 @@ development/ editable mode `pip install -e .`
48
49
``` {important}
49
50
Be sure
50
51
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
52
53
be found at the top of the review issue. In the example below you can
53
54
see that `pyrolite` version 0.2.5
54
55
was submitted for review.
Original file line number Diff line number Diff line change @@ -32,7 +32,7 @@ Try to balance your sense of the potential reviewer’s experience against the c
32
32
33
33
Each submission should be reviewed by _ two_ package reviewers. Although it is
34
34
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
36
36
the package comprehensively, from their particular perspectives. In
37
37
general, at least one reviewer should have prior reviewing experience, and of
38
38
course inviting one new reviewer expands our pool of reviewers.
You can’t perform that action at this time.
0 commit comments