Shorten and improve CONTRIBUTING.md #12801
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
Simplified CONTRIBUTING.md by removing content that already exists in contributing.rst. Added Code of Conduct reference as seen in a few other CONTRIBUTING.md of popular libraries.
In shortening `CONTRIBUTING.md`, material deleted from `how to contribute` section are added onto `contributing.rst` if it doens't exist on the latter.
|
Interesting, is the content being removed from the file all also included in the other file? |
Not sure. I did see a merge conflict when syncing. Did I lose content? |
|
I'm not sure, it'd be nice if you could double check that. |
…into contributing_doc
jnothman
reviewed
Dec 18, 2018
CONTRIBUTING.md
Outdated
| documentation is no less important than improving the library itself. If you | ||
| find a typo in the documentation, or have made improvements, do not hesitate to | ||
| send an email to the mailing list or preferably submit a GitHub pull request. | ||
| Full documentation can be found under the |
There was a problem hiding this comment.
It's not honest to say "Full documentation" as the documentation includes API docstrings and the example gallery, which do not live in doc. Perhaps just say "Documentation"
CONTRIBUTING.md
Outdated
| Guideline | ||
| --------- | ||
|
|
||
| Full contribution guidelines are available in the repository at `doc\`, or |
There was a problem hiding this comment.
how about explciitly mentioning doc/developers/contributing.rst?
added 2 commits
December 18, 2018 09:44
jnothman
approved these changes
Dec 18, 2018
doc/developers/contributing.rst
Outdated
| method does to the data. Then, it is very helpful to point out why the feature is | ||
| useful and when it should be used - the latter also including "big O" | ||
| (:math:`O\left(g\left(n\right)\right)`) complexities of the algorithm, as opposed | ||
| to just *rules of thumb*,as the latter can be very machine-dependent. If those |
added 2 commits
December 18, 2018 17:54
adrinjalali
approved these changes
Dec 19, 2018
adrinjalali
pushed a commit
to adrinjalali/scikit-learn
that referenced
this pull request
Jan 7, 2019
* Reuse intro from contributing.rst * Removed content already on rst Simplified CONTRIBUTING.md by removing content that already exists in contributing.rst. Added Code of Conduct reference as seen in a few other CONTRIBUTING.md of popular libraries. * Update contributing.rst In shortening `CONTRIBUTING.md`, material deleted from `how to contribute` section are added onto `contributing.rst` if it doens't exist on the latter. * added full link to .rst file + removed 'Full' in 'Full Docum...'
jnothman
pushed a commit
to jnothman/scikit-learn
that referenced
this pull request
Feb 19, 2019
* Reuse intro from contributing.rst * Removed content already on rst Simplified CONTRIBUTING.md by removing content that already exists in contributing.rst. Added Code of Conduct reference as seen in a few other CONTRIBUTING.md of popular libraries. * Update contributing.rst In shortening `CONTRIBUTING.md`, material deleted from `how to contribute` section are added onto `contributing.rst` if it doens't exist on the latter. * added full link to .rst file + removed 'Full' in 'Full Docum...'
xhluca
pushed a commit
to xhluca/scikit-learn
that referenced
this pull request
Apr 28, 2019
* Reuse intro from contributing.rst * Removed content already on rst Simplified CONTRIBUTING.md by removing content that already exists in contributing.rst. Added Code of Conduct reference as seen in a few other CONTRIBUTING.md of popular libraries. * Update contributing.rst In shortening `CONTRIBUTING.md`, material deleted from `how to contribute` section are added onto `contributing.rst` if it doens't exist on the latter. * added full link to .rst file + removed 'Full' in 'Full Docum...'
xhluca
pushed a commit
to xhluca/scikit-learn
that referenced
this pull request
Apr 28, 2019
This reverts commit 9d8cdf1.
xhluca
pushed a commit
to xhluca/scikit-learn
that referenced
this pull request
Apr 28, 2019
This reverts commit 9d8cdf1.
koenvandevelde
pushed a commit
to koenvandevelde/scikit-learn
that referenced
this pull request
Jul 12, 2019
* Reuse intro from contributing.rst * Removed content already on rst Simplified CONTRIBUTING.md by removing content that already exists in contributing.rst. Added Code of Conduct reference as seen in a few other CONTRIBUTING.md of popular libraries. * Update contributing.rst In shortening `CONTRIBUTING.md`, material deleted from `how to contribute` section are added onto `contributing.rst` if it doens't exist on the latter. * added full link to .rst file + removed 'Full' in 'Full Docum...'
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.
Referencing PR / Issue
This fixes #10892, closes #12144
Note
simplify CONTRIBUTING.md file
cc: @cecilialiao
cc: @eharris99 (12215 PR closed previously)
#wimlds