@@ -4,7 +4,7 @@ Core Developer Guide
4
4
====================
5
5
6
6
As a core developer, you should continue making pull requests
7
- in accordance with the :ref: `devguide `.
7
+ in accordance with the :ref: `chap_devguide `.
8
8
You are responsible for shepherding other contributors through the review process.
9
9
You also have the ability to merge or approve other contributors' pull requests.
10
10
@@ -38,7 +38,7 @@ When reviewing, focus on the following:
38
38
should avoid side-effects such as changing global state or modifying
39
39
input variables.
40
40
41
- 2. **Documentation: ** Any new feature should have a gallery
41
+ 2. **Documentation: ** Any new feature should have a tutorial
42
42
example that not only illustrates but explains it.
43
43
44
44
3. **The algorithm: ** You should understand the code being modified or
@@ -63,7 +63,7 @@ or using GitHub’s `suggestion
63
63
whether to accept the changes.)
64
64
65
65
Our default merge policy is to squash all PR commits into a single
66
- commit. Users who wish to bring the latest changes from ``main ``
66
+ commit. Users who wish to bring the latest changes from ``master ``
67
67
into their branch should be advised to merge, not to rebase. Even
68
68
when merge conflicts arise, don’t ask for a rebase unless you know
69
69
that a contributor is experienced with git. Instead, rebase the branch
@@ -108,15 +108,15 @@ for a number of reasons:
108
108
- fixing the issue is difficult, and it is deemed too niche a use case to
109
109
devote sustained effort or prioritize over other issues; or
110
110
- the use case or feature request is something that core developers feel
111
- does not belong in NetworkX ,
111
+ does not belong in Nibabel ,
112
112
113
113
among others. Similarly, pull requests sometimes need to be closed without
114
114
merging, because:
115
115
116
116
- the pull request implements a niche feature that we consider not worth the
117
117
added maintenance burden;
118
118
- the pull request implements a useful feature, but requires significant
119
- effort to bring up to NetworkX 's standards, and the original
119
+ effort to bring up to Nibabel 's standards, and the original
120
120
contributor has moved on, and no other developer can be found to make the
121
121
necessary changes; or
122
122
- the pull request makes changes that do not align with our values, such as
@@ -145,17 +145,22 @@ Further resources
145
145
As a core member, you should be familiar with community and developer
146
146
resources such as:
147
147
148
- - Our :ref: `contributor_guide `
148
+ - Our :ref: `chap_devguide `
149
149
- Our :ref: `code_of_conduct `
150
150
- `PEP8 <https://www.python.org/dev/peps/pep-0008/ >`__ for Python style
151
151
- `PEP257 <https://www.python.org/dev/peps/pep-0257/ >`__ and the `NumPy
152
152
documentation
153
153
guide <https://numpy.org/doc/stable/docs/howto_document.html> `__
154
154
for docstrings. (NumPy docstrings are a superset of PEP257. You
155
155
should read both.)
156
- - The NetworkX `tag on
157
- StackOverflow <https://stackoverflow.com/questions/tagged/networkx> `__
156
+ - The Nibabel `tag on NeuroStars <https://neurostars.org/tag/nibabel >`__
158
157
- Our `mailing
159
- list <http ://groups.google.com/group/networkx-discuss/ > `__
158
+ list <https ://mail.python.org/mailman/listinfo/neuroimaging > `__
160
159
161
160
You are not required to monitor all of the social resources.
161
+
162
+ Acknowledgments
163
+ ===============
164
+
165
+ This document is based on the `NetworkX Core Developer guide
166
+ <https://networkx.org/documentation/latest/developer/core_developer.html> `_.
0 commit comments