[MRG] DOC: add install mode to contribute #12850
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…nto doc_addInstallModeToContribute
…nto doc_addInstallModeToContribute
eamanu
approved these changes
Dec 29, 2018
jnothman
reviewed
Dec 31, 2018
| 4. Create a branch to hold your development changes:: | ||
| 4. Install library in editable mode:: | ||
|
|
||
| $ pip install --editable . |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
jnothman
approved these changes
Jan 7, 2019
|
Thanks |
jnothman
reviewed
Jan 7, 2019
doc/developers/contributing.rst
Outdated
|
|
||
| $ pip install --editable . | ||
|
|
||
| for more details about advanced installation, see the :ref:`install_bleeding_edge` section. |
There was a problem hiding this comment.
Please reduce this line to under 80 chars.
|
Glad to contribute for the first time ! Thanks to all reviewers, I have already learned a lot! |
jnothman
pushed a commit
to jnothman/scikit-learn
that referenced
this pull request
Feb 19, 2019
xhluca
pushed a commit
to xhluca/scikit-learn
that referenced
this pull request
Apr 28, 2019
xhluca
pushed a commit
to xhluca/scikit-learn
that referenced
this pull request
Apr 28, 2019
This reverts commit e2e45a0.
xhluca
pushed a commit
to xhluca/scikit-learn
that referenced
this pull request
Apr 28, 2019
This reverts commit e2e45a0.
koenvandevelde
pushed a commit
to koenvandevelde/scikit-learn
that referenced
this pull request
Jul 12, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
Fixes #12815
What does this implement/fix? Explain your changes.
Improve contributing documentation by adding the installation in editable mode and link to advanced installation