If you are a first-time contributor:
Go to 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 firstname.lastname@example.org:your-username/networkx.git
Add the upstream repository:
git remote add upstream email@example.com:networkx/networkx.git
Now, you have remote repositories named:
upstream, which refers to the
origin, which refers to your personal fork
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 (
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 to explain your changes or to ask for review.
For a more detailed discussion, read these detailed documents on how to use Git with
- 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, 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, is another continuous integration service, which we use. You will also need to make sure that the AppVeyor tests pass.
If closing a bug, also add “Fixes #1480” where 1480 is the issue number.
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
Set up your editor to remove trailing whitespace. Follow PEP08. Check code with
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
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
For additional information about contributing to NetworkX, please see the Developer Notes.