[WIP] Shorten and improve CONTRIBUTING.md #10892 #12144
Closed
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.
|
I think we need to ensure that everything we remove in CONTRIBUTING.md is included the contributing guide. E.g., some entries in Pull Request Checklist are not included in the contributing guide. |
|
That's a great shout, I will look to add the deleted content from |
|
Yes, simply push commits to that branch and they'll appear in the PR |
In shortening `CONTRIBUTING.md`, material deleted from `how to contribute` section are added onto `contributing.rst` if it doens't exist on the latter.
jnothman
reviewed
Sep 29, 2018
|
|
||
| But there are many other ways to help. In particular answering queries on the | ||
| [issue tracker](https://github.com/scikit-learn/scikit-learn/issues), | ||
| investigating bugs, and [reviewing other developers pull |
There was a problem hiding this comment.
Apostrophe after "developers" please
| Another way to contribute is to report issues you're facing, and give a "thumbs | ||
| up" on issues that others reported and that are relevant to you. It also helps | ||
| us if you spread the word: reference the project from your blog and articles, | ||
| link to it from your website, or simply star to say "I use it". |
Closed
|
Hi I also submitted some proposed edits to this file |
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.
Fixes #10892, by simplifying
CONTRIBUTING.mdand referencing todoc\where appropriate.