From af34030c34e39bd9f314fbb83d46a720fe0e1168 Mon Sep 17 00:00:00 2001 From: Jaques Grobler <jaquesgrobler@gmail.com> Date: Wed, 1 Feb 2012 15:29:51 +0100 Subject: [PATCH] Added a small note about the use of an upstream remote in the Contributions documentation --- doc/developers/index.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/developers/index.rst b/doc/developers/index.rst index 455a6dbbd6..ce881fff38 100644 --- a/doc/developers/index.rst +++ b/doc/developers/index.rst @@ -103,6 +103,16 @@ the web page of the repo, and click on 'Pull request' to send us a pull request. This will send an email to the commiters, but might also send an email to the mailing list in order to get more visibility. +.. note:: + + In the above setup, your ``origin`` remote-repository points to + YourLogin/scikit-learn.git. If you wish to `fetch/merge` from the main repository instead of your `forked` one, you'll need + to add another remote to use instead of ``origin``. If we choose the name + ``upstream`` for it, the command will be:: + + $ git remote add upstream git@github.com:scikit-learn/scikit-learn.git + + (If any of the above seems like magic to you, then look up the `Git documentation <http://git-scm.com/documentation>`_ on the web.) -- GitLab