Skip to content

Commit 519bedc

Browse files
Kevin Yu-Sheng Liqinhanmin2014
Kevin Yu-Sheng Li
authored and
qinhanmin2014
committed
DOC Fix note range in contributing.html (#13722)
1 parent 612a04e commit 519bedc

File tree

1 file changed

+42
-42
lines changed

1 file changed

+42
-42
lines changed

‎doc/developers/contributing.rst

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -195,67 +195,67 @@ The preferred way to contribute to scikit-learn is to fork the `main
195195
repository <https://github.com/scikit-learn/scikit-learn/>`__ on GitHub,
196196
then submit a "pull request" (PR):
197197

198-
1. `Create an account <https://github.com/join>`_ on
199-
GitHub if you do not already have one.
198+
1. `Create an account <https://github.com/join>`_ on
199+
GitHub if you do not already have one.
200200

201-
2. Fork the `project repository
202-
<https://github.com/scikit-learn/scikit-learn>`__: click on the 'Fork'
203-
button near the top of the page. This creates a copy of the code under your
204-
account on the GitHub user account. For more details on how to fork a
205-
repository see `this guide <https://help.github.com/articles/fork-a-repo/>`_.
201+
2. Fork the `project repository
202+
<https://github.com/scikit-learn/scikit-learn>`__: click on the 'Fork'
203+
button near the top of the page. This creates a copy of the code under your
204+
account on the GitHub user account. For more details on how to fork a
205+
repository see `this guide <https://help.github.com/articles/fork-a-repo/>`_.
206206

207-
3. Clone your fork of the scikit-learn repo from your GitHub account to your
208-
local disk::
207+
3. Clone your fork of the scikit-learn repo from your GitHub account to your
208+
local disk::
209209

210-
$ git clone git@github.com:YourLogin/scikit-learn.git
211-
$ cd scikit-learn
210+
$ git clone git@github.com:YourLogin/scikit-learn.git
211+
$ cd scikit-learn
212212

213-
4. Install library in editable mode::
213+
4. Install library in editable mode::
214214

215-
$ pip install --editable .
215+
$ pip install --editable .
216216

217-
for more details about advanced installation, see the
218-
:ref:`install_bleeding_edge` section.
217+
for more details about advanced installation, see the
218+
:ref:`install_bleeding_edge` section.
219219

220-
5. Create a branch to hold your development changes::
220+
5. Create a branch to hold your development changes::
221221

222-
$ git checkout -b my-feature
222+
$ git checkout -b my-feature
223223

224-
and start making changes. Always use a ``feature`` branch. It's good practice to
225-
never work on the ``master`` branch!
224+
and start making changes. Always use a ``feature`` branch. It's good practice to
225+
never work on the ``master`` branch!
226226

227-
.. note::
227+
.. note::
228228

229-
In the above setup, your ``origin`` remote repository points to
230-
``YourLogin/scikit-learn.git``. If you wish to fetch/merge from the main
231-
repository instead of your forked one, you will need to add another remote
232-
to use instead of ``origin``. If we choose the name ``upstream`` for it, the
233-
command will be::
229+
In the above setup, your ``origin`` remote repository points to
230+
``YourLogin/scikit-learn.git``. If you wish to fetch/merge from the main
231+
repository instead of your forked one, you will need to add another remote
232+
to use instead of ``origin``. If we choose the name ``upstream`` for it, the
233+
command will be::
234234

235-
$ git remote add upstream https://github.com/scikit-learn/scikit-learn.git
235+
$ git remote add upstream https://github.com/scikit-learn/scikit-learn.git
236236

237-
And in order to fetch the new remote and base your work on the latest changes
238-
of it you can::
237+
And in order to fetch the new remote and base your work on the latest changes
238+
of it you can::
239239

240-
$ git fetch upstream
241-
$ git checkout -b my-feature upstream/master
240+
$ git fetch upstream
241+
$ git checkout -b my-feature upstream/master
242242

243-
6. Develop the feature on your feature branch on your computer, using Git to do the
244-
version control. When you're done editing, add changed files using ``git add``
245-
and then ``git commit`` files::
243+
6. Develop the feature on your feature branch on your computer, using Git to do the
244+
version control. When you're done editing, add changed files using ``git add``
245+
and then ``git commit`` files::
246246

247-
$ git add modified_files
248-
$ git commit
247+
$ git add modified_files
248+
$ git commit
249249

250-
to record your changes in Git, then push the changes to your GitHub account with::
250+
to record your changes in Git, then push the changes to your GitHub account with::
251251

252-
$ git push -u origin my-feature
252+
$ git push -u origin my-feature
253253

254-
7. Follow `these
255-
<https://help.github.com/articles/creating-a-pull-request-from-a-fork>`_
256-
instructions to create a pull request from your fork. This will send an
257-
email to the committers. You may want to consider sending an email to the
258-
mailing list for more visibility.
254+
7. Follow `these
255+
<https://help.github.com/articles/creating-a-pull-request-from-a-fork>`_
256+
instructions to create a pull request from your fork. This will send an
257+
email to the committers. You may want to consider sending an email to the
258+
mailing list for more visibility.
259259

260260
.. note::
261261

0 commit comments

Comments
 (0)