8000 Shorten and improve CONTRIBUTING.md · Issue #10892 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

Shorten and improve CONTRIBUTING.md #10892

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

Jump to bottom
Closed
lesteve opened this issue Mar 30, 2018 · 9 comments · Fixed by #12801
Closed

Shorten and improve CONTRIBUTING.md #10892

lesteve opened this issue Mar 30, 2018 · 9 comments · Fixed by #12801
Labels
Documentation Easy Well-defined and straightforward way to resolve good first issue Easy with clear instructions to resolve help wanted

Comments

@lesteve
Copy link
Member
lesteve commented Mar 30, 2018 •
edited
Loading

As mentioned in #9958 (comment), people are more likely to bump into CONTRIBUTING.md than the contributing doc on scikit-learn.org before opening an issue or PR.

CONTRIBUTING.md should have very little content and points to the relevant portion of the scikit-lern.org dev (because stable can lag behind quite a bit) doc. Here are a few points that are worth mentioning:

Filing issues

Use the template provided: What you did, what you expect, what you got, scikit-learn and dependencies version. Full traceback if you get an error. A stand-alone snippet makes it a lot more likely to get good feedback.

Link to dev doc for all the details.

Pull requests

For contributing Pull Requests:

  • if you are not familiar with Pull Request, relevant link to https://opensource.guide/ or relevant help.github.com link
  • install the scikit-learn dev version, link to dev doc
  • make sure you can run the tests localy, link to the dev doc

For more details, link to the dev doc

Other things:

  • Other ways to contribute, reviewing pull request, improve the doc, answer questions on github and/or StackOverflow and/or the mailing list.
  • Link to first good issue, easy issues, help needed issues, maybe bug issues
  • other things I may have missed

I may have missed things, obviously comments more than welcome.

Related things were discussed in #9958 and probably others.

cc @mohamed-ali who said he may be interested to work on this.

A few contributing guide I could find:
numpy
scipy
pandas
dask
requests
django
lesteve referenced this issue Mar 30, 2018
@lesteve
DOC Link to dev doc in CONTRIBUTING.md
158c7a5
@mohamed-ali
Copy link
Contributor

@lesteve Thanks for pinging me. I'll work on this.
I was also thinking about either linking to this visual guide on how to make a first contribution or create a dedicated page with the same content customized for scikit-learn.

@lesteve
Copy link
Member Author
lesteve commented Mar 30, 2018

I was also thinking about either linking to this visual guide

At a glance, this looks nice. I would rather link so that we don't have to maintain the instructions ourselves.

@mohamed-ali mohamed-ali mentioned this issue Apr 4, 2018
Merged
@qinhanmin2014 qinhanmin2014 added Easy Well-defined and straightforward way to resolve good first issue Easy with clear instructions to resolve labels May 9, 2018
@cecilialiao
Copy link

Hello, I attended a workshop on first open source contribution which, after a bit of searching, led me to this issue. I can do a bit of reearch into the CONTRIBUTING.md of other popular libraries and have a go at shortening the one for scikit-learn. Is this something I can help with?

@rth
Copy link
Member
rth commented Sep 17, 2018

Thank you @cecilialiao , improving CONTRIBUTING.md would be very much appreciated!

@adrinjalali
Copy link
Member

thanks @cecilialiao, do you think you could also help with and include this issue: #12111 (comment)

@cecilialiao
Copy link

@adrinjalali Would it make more sense to include #12111 in the full documentation (https://github.com/scikit-learn/scikit-learn/tree/master/doc) rather than CONTRIBUTING.md?

@qinhanmin2014
Copy link
Member

@adrinjalali Would it make more sense to include #12111 in the full documentation (https://github.com/scikit-learn/scikit-learn/tree/master/doc) rather than CONTRIBUTING.md?

We've decided not to mention it. I think the main purpose of this PR is reorganizing, not adding things.

@cecilialiao cecilialiao mentioned this issue Sep 24, 2018
Closed
@cecilialiao
Copy link

I created PR #12144. But in doing so, I noticed that the pull request comment box is prepopulated to reference to a section of CONTRIBUTING.md, which I have removed.

<!--
Thanks for contributing a pull request! Please ensure you have taken a look at
the contribution guidelines: https://github.com/scikit-learn/scikit-learn/blob/master/CONTRIBUTING.md#pull-request-checklist
-->

Is it possible to change the pre-populated field to reference the live documentation, or should I add the pull-request-checklist back onto CONTRIBUTING.md?

@eharris99
Copy link

I am attending a workshop on first open-source contribution. May I suggest some rephrasing and cuts in a pull request?

@eharris99 eharris99 mentioned this issue Sep 29, 2018
Closed
@reshamas reshamas mentioned this issue Dec 17, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Easy Well-defined and straightforward way to resolve good first issue Easy with clear instructions to resolve help wanted
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Shorten and improve CONTRIBUTING.md
7 participants
@rth @adrinjalali @lesteve @mohamed-ali @cecilialiao @eharris99 @qinhanmin2014
0