8000 [MRG] DOC More detailed pull request and fork instructions (#8530) (#… · jwjohnson314/scikit-learn@0b6d32b · GitHub
[go: up one dir, main page]

Skip to content

Commit 0b6d32b

Browse files
tfolkmanJeremiah Johnson
authored andcommitted
[MRG] DOC More detailed pull request and fork instructions (scikit-learn#8530) (scikit-learn#8538)
1 parent 84f4fc3 commit 0b6d32b

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ GitHub, clone, and develop on a branch. Steps:
1818

1919
1. Fork the [project repository](https://github.com/scikit-learn/scikit-learn)
2020
by clicking on the 'Fork' button near the top right of the page. This creates
21-
a copy of the code under your GitHub user account.
21+
a copy of the code under your GitHub user account. For more details on
22+
how to fork a repository see [this guide](https://help.github.com/articles/fork-a-repo/).
2223

2324
2. Clone your fork of the scikit-learn repo from your GitHub account to your local disk:
2425

@@ -48,9 +49,8 @@ GitHub, clone, and develop on a branch. Steps:
4849
$ git push -u origin my-feature
4950
```
5051

51-
5. Go to the GitHub web page of your fork of the scikit-learn repo.
52-
Click the 'Pull request' button to send your changes to the project's maintainers for
53-
review. This will send an email to the committers.
52+
5. Follow [these instructions](https://help.github.com/articles/creating-a-pull-request-from-a-fork)
53+
to create a pull request from your fork. This will send an email to the committers.
5454

5555
(If any of the above seems like magic to you, please look up the
5656
[Git documentation](https://git-scm.com/documentation) on the web, or ask a friend or another contributor for help.)

doc/developers/contributing.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@ then submit a "pull request" (PR):
111111
2. Fork the `project repository
112112
<https://github.com/scikit-learn/scikit-learn>`__: click on the 'Fork'
113113
button near the top of the page. This creates a copy of the code under your
114-
account on the GitHub server.
114+
account on the GitHub server. For more details on how to fork a
115+
repository see `this guide <https://help.github.com/articles/fork-a-repo/>`_.
115116

116117
3. Clone this copy to your local disk::
117118

@@ -133,10 +134,11 @@ then submit a "pull request" (PR):
133134

134135
$ git push -u origin my-feature
135136

136-
Finally, go to the web page of the your fork of the scikit-learn repo,
137-
and click 'Pull request' to send your changes to the maintainers for review.
138-
You may want to consider sending an email to the mailing list for more
139-
visibility.
137+
Finally, follow `these
138+
<https://help.github.com/articles/creating-a-pull-request-from-a-fork>`_
139+
instructions to create a pull request from your fork. This will send an
140+
email to the committers. You may want to consider sending an email to the
141+
mailing list for more visibility.
140142

141143
.. note::
142144

0 commit comments

Comments
 (0)
0