Skip to content

[MRG] DOC: add install mode to contribute #12850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jan 9, 2019
Merged

[MRG] DOC: add install mode to contribute #12850

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
2a06465
add stage in contribution steps
jmehault Dec 18, 2018
4d2d688
Merge branch 'master' of git://github.com/scikit-learn/scikit-learn i…
jmehault Dec 18, 2018
2b829ab
add link to Advanced installation section
jmehault Dec 21, 2018
8092890
fix link
jmehault Dec 21, 2018
2e59216
Merge branch 'master' of git://github.com/scikit-learn/scikit-learn i…
jmehault Dec 21, 2018
7630c3f
fix conflicts
jmehault Dec 21, 2018
d7110a6
fix conflicts
jmehault Jan 4, 2019
f093822
Merge remote-tracking branch 'upstream/master'
jmehault Jan 4, 2019
0a0b408
update my branch
jmehault Jan 4, 2019
3ba71df
fix conflicts
jmehault Jan 4, 2019
5d1a8ae
add note about cython modules modifications
jmehault Jan 4, 2019
1f35026
reduce lines width to 80 chars
jmehault Jan 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions doc/developers/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,15 +196,22 @@ then submit a "pull request" (PR):
$ git clone git@github.com:YourLogin/scikit-learn.git
$ cd scikit-learn

4. Create a branch to hold your development changes::
4. Install library in editable mode::

$ pip install --editable .
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Problem putting this here is that it's not required for documentation changes, or really is only required if you want to run the tests. And if you're modifying cython modules you will need to re run this after changing and before testing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be we should list every steps and add details for contribution to documentation only or cython modules ? And link to the related sections if needed. In that way, we will have a single complete recipe.


for more details about advanced installation, see the
:ref:`install_bleeding_edge` section.

5. Create a branch to hold your development changes::

$ git checkout -b my-feature

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

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

$ git add modified_files
Expand All @@ -214,12 +221,17 @@ then submit a "pull request" (PR):

$ git push -u origin my-feature

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

.. note::

If you are modifying a Cython module, you have to re-run step 4 after modifications
and before testing them.

.. note::

In the above setup, your ``origin`` remote repository points to
Expand Down