Skip to content

Commit

Permalink
Update contributing.rst
Browse files Browse the repository at this point in the history
Advise to merge instead of rebase when it's been a while, to avoid the situation of #1015
  • Loading branch information
nguigs authored and ninamiolane committed Jul 14, 2021
1 parent f9ed6bb commit a9f82cd
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,12 +167,20 @@ modifying code and submitting a PR:
mailing list hi@geomstats.ai for more visibility.

It is often helpful to keep your local feature branch synchronized with the
latest changes of the main geomstats repository::
latest changes of the main geomstats repository. If there are only a few new
commits in the master branch, use::

$ git fetch upstream
$ git rebase upstream/master

Subsequently, you might need to solve potential conflicts. Refer to the
Subsequently, you might need to solve potential conflicts.
If it's been a while since you've last updated your branch, it might be easier
to merge the master branch into yours::

$ git fetch upstream
$ git merge upstream/master

Refer to the
`Git documentation related to resolving merge conflict using the command
line
<https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/>`_.
Expand Down

0 comments on commit a9f82cd

Please sign in to comment.