1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
Developer overview
==================
1. If you are a first-time contributor:
* Go to `https://github.com/networkx/networkx
<https://github.com/networkx/networkx>`_ and click the
"fork" button to create your own copy of the project.
* Clone the project to your local computer::
git clone git@github.com:your-username/networkx.git
* Add the upstream repository::
git remote add upstream git@github.com:networkx/networkx.git
* Now, you have remote repositories named:
- ``upstream``, which refers to the ``networkx`` repository
- ``origin``, which refers to your personal fork
2. Develop your contribution:
* Pull the latest changes from upstream::
git checkout master
git pull upstream master
* Create a branch for the feature you want to work on. Since the
branch name will appear in the merge message, use a sensible name
such as 'bugfix-for-issue-1480'::
git checkout -b bugfix-for-issue-1480
* Commit locally as you progress (``git add`` and ``git commit``)
3. To submit your contribution:
* Push your changes back to your fork on GitHub::
git push origin bugfix-for-issue-1480
* Go to GitHub. The new branch will show up with a green Pull Request
button---click it.
* If you want, post on the `mailing list
<http://groups.google.com/group/networkx-discuss>`_ to explain your changes or
to ask for review.
For a more detailed discussion, read these :doc:`detailed documents
<gitwash/index>` on how to use Git with ``networkx``
(`<https://networkx.readthedocs.io/en/stable/developer/gitwash/index.html>`_).
4. Review process:
* Reviewers (the other developers and interested community members) will
write inline and/or general comments on your Pull Request (PR) to help
you improve its implementation, documentation, and style. Every single
developer working on the project has their code reviewed, and we've come
to see it as friendly conversation from which we all learn and the
overall code quality benefits. Therefore, please don't let the review
discourage you from contributing: its only aim is to improve the quality
of project, not to criticize (we are, after all, very grateful for the
time you're donating!).
* To update your pull request, make your changes on your local repository
and commit. As soon as those changes are pushed up (to the same branch as
before) the pull request will update automatically.
* `Travis-CI <http://travis-ci.org/>`_, a continuous integration service,
is triggered after each Pull Request update to build the code and run unit
tests of your branch. The Travis tests must pass before your PR can be merged.
If Travis fails, you can find out why by clicking on the "failed" icon (red
cross) and inspecting the build and test log.
* `AppVeyor <http://ci.appveyor.com>`_, is another continuous integration
service, which we use. You will also need to make sure that the AppVeyor
tests pass.
.. note::
If closing a bug, also add "Fixes #1480" where 1480 is the issue number.
Divergence between ``upstream master`` and your feature branch
--------------------------------------------------------------
Never merge the main branch into yours. If GitHub indicates that the
branch of your Pull Request can no longer be merged automatically, rebase
onto master::
git checkout master
git pull upstream master
git checkout bugfix-for-issue-1480
git rebase master
If any conflicts occur, fix the according files and continue::
git add conflict-file1 conflict-file2
git rebase --continue
However, you should only rebase your own branches and must generally not
rebase any branch which you collaborate on with someone else.
Finally, you must push your rebased branch::
git push --force origin bugfix-for-issue-1480
(If you are curious, here's a further discussion on the
`dangers of rebasing <http://tinyurl.com/lll385>`_.
Also see this `LWN article <http://tinyurl.com/nqcbkj>`_.)
Guidelines
----------
* All code should have tests.
* All code should be documented, to the same
`standard <https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#docstring-standard>`_
as NumPy and SciPy.
* All changes are reviewed. Ask on the
`mailing list <http://groups.google.com/group/networkx-discuss>`_ if
you get no response to your pull request.
Stylistic Guidelines
--------------------
* Set up your editor to remove trailing whitespace.
Follow `PEP08 <www.python.org/dev/peps/pep-0008/>`_.
Check code with `pyflakes` / `flake8`.
* Use the following import conventions::
import numpy as np
import scipy as sp
import matplotlib as mpl
import matplotlib.pyplot as plt
import networkx as nx
cimport numpy as cnp # in Cython code
Pull request codes
------------------
When you submit a pull request to GitHub, GitHub will ask you for a summary. If
your code is not ready to merge, but you want to get feedback, please consider
using ``WIP: experimental optimization`` or similar for the title of your pull
request. That way we will all know that it's not yet ready to merge and that
you may be interested in more fundamental comments about design.
When you think the pull request is ready to merge, change the title (using the
*Edit* button) to remove the ``WIP:``.
Developer Notes
---------------
For additional information about contributing to NetworkX, please see
the `Developer Notes <https://github.com/networkx/networkx/wiki>`_.
Bugs
----
Please `report bugs on GitHub <https://github.com/networkx/networkx/issues>`_.
|
