@@ -14,13 +14,13 @@ Reviewing
14
14
How to Conduct A Good Review
15
15
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16
16
17
- *Always * be kind to contributors. Nearly all of NetworkX is
17
+ *Always * be kind to contributors. Nearly all of Nibabel is
18
18
volunteer work, for which we are tremendously grateful. Provide
19
19
constructive criticism on ideas and implementations, and remind
20
20
yourself of how it felt when your own work was being evaluated as a
21
21
novice.
22
22
23
- NetworkX strongly values mentorship in code review. New users
23
+ Nibabel strongly values mentorship in code review. New users
24
24
often need more handholding, having little to no git
25
25
experience. Repeat yourself liberally, and, if you don’t recognize a
26
26
contributor, point them to our development guide, or other GitHub
@@ -33,12 +33,10 @@ an abandoned pull request.
33
33
When reviewing, focus on the following:
34
34
35
35
1. **API: ** The API is what users see when they first use
36
- NetworkX. APIs are difficult to change once released, so
37
- should be simple, `functional
38
- <https://en.wikipedia.org/wiki/Functional_programming> `__ (i.e. not
39
- carry state), consistent with other parts of the library, and
40
- should avoid modifying input variables. Please familiarize
41
- yourself with the project's :ref: `deprecation_policy `.
36
+ Nibabel. APIs are difficult to change once released, so
37
+ should be simple, consistent with other parts of the library, and
38
+ should avoid side-effects such as changing global state or modifying
39
+ input variables.
42
40
43
41
2. **Documentation: ** Any new feature should have a gallery
44
42
example that not only illustrates but explains it.
0 commit comments