diff options
author | Jarrod Millman <jarrod.millman@gmail.com> | 2021-03-04 13:22:44 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-03-04 13:22:44 -0800 |
commit | f9570289c7abd568714e4114e0b9ce1d0ddc5dcf (patch) | |
tree | e9823cc1c58d752604a23f053d263e27b7245877 /CONTRIBUTING.rst | |
parent | 00a2ff9ecca3787d9c55956ecc5a135470e0d6f3 (diff) | |
download | networkx-f9570289c7abd568714e4114e0b9ce1d0ddc5dcf.tar.gz |
Make main default branch (and remove gitwash) (#4649)
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r-- | CONTRIBUTING.rst | 30 |
1 files changed, 12 insertions, 18 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 9ddc21cf..9c699f56 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -87,8 +87,8 @@ Development Workflow * Pull the latest changes from upstream:: - git checkout master - git pull upstream master + git checkout main + git pull upstream main * 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 @@ -108,7 +108,6 @@ Development Workflow problems early and reduces the load on the continuous integration system. - 4. Submit your contribution: * Push your changes back to your fork on GitHub:: @@ -122,10 +121,6 @@ Development Workflow <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.org/documentation/latest/developer/gitwash/index.html>`_). - 5. Review process: * Every Pull Request (PR) update triggers a set of `continuous integration @@ -196,14 +191,14 @@ For a more detailed discussion, read these :doc:`detailed documents where 123 is the issue number. -Divergence from ``upstream master`` ------------------------------------ +Divergence from ``upstream main`` +--------------------------------- If GitHub indicates that the branch of your Pull Request can no longer -be merged automatically, merge the master branch into yours:: +be merged automatically, merge the main branch into yours:: - git fetch upstream master - git merge upstream/master + git fetch upstream main + git merge upstream/main If any conflicts occur, they need to be fixed before continuing. See which files are in conflict using:: @@ -222,8 +217,8 @@ Inside the conflicted file, you'll find sections like these:: <<<<<<< HEAD The way the text looks in your branch ======= - The way the text looks in the master branch - >>>>>>> master + The way the text looks in the main branch + >>>>>>> main Choose one version of the text that should be kept, and delete the rest:: @@ -241,9 +236,8 @@ Once you've fixed all merge conflicts, do:: .. note:: - Advanced Git users are encouraged to `rebase instead of merge - <https://networkx.org/documentation/stable/developer/gitwash/development_workflow.html#rebase-on-trunk>`__, - but we squash and merge most PRs either way. + Advanced Git users may want to rebase instead of merge, + but we squash and merge PRs either way. Guidelines @@ -251,7 +245,7 @@ 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>`_ + `standard <https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard>`_ as NumPy and SciPy. * All changes are reviewed. Ask on the `mailing list <http://groups.google.com/group/networkx-discuss>`_ if |