Skip to content
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.

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

moving contributing into the docs #453

Merged
merged 2 commits into from Oct 24, 2018

Conversation

@choldgraf
Copy link
Collaborator

choldgraf commented Oct 22, 2018

closes #439, moving it into the documentation of the main repo2docker site. Also does a bit of refactoring of the dev docs

disk.

```bash
git clone https://github.com/jupyter/repo2docker

This comment has been minimized.

Copy link
@betatim

betatim Oct 23, 2018

Member

Should we tell people to clone their own fork instead? The thing that is missing from there docs is the final step of making a PR :-/

Or we leave it for now?

@betatim

This comment has been minimized.

Copy link
Member

betatim commented Oct 23, 2018

Can we save some effort by copying http://scikit-learn.org/stable/developers/contributing.html#how-to-contribute for the "how to setup for local development" section?

@choldgraf

This comment has been minimized.

Copy link
Collaborator Author

choldgraf commented Oct 23, 2018

@betatim good call on cloning from a forked repository. re: copying from scikit-learn, I think that generally sounds like a good idea...do you think we could do that in another PR to improve the docs?

@betatim

This comment has been minimized.

Copy link
Member

betatim commented Oct 24, 2018

Let's do that in a new PR. We should probably do a bit of a stock take of what we have in the docs where, what mode of operation which bit recommends and do a unification edit. I think our docs have grown in small bursts over time so there are pieces which aren't super consistent with each other. Not a massive problem for more experienced contributors, massively confusing for newcomers. Maybe step one is agreeing on how we think a contribution should be made and having a checklist of steps-to-merged-contribution that people can follow.

@betatim betatim merged commit c909334 into jupyter:master Oct 24, 2018
4 checks passed
4 checks passed
ci/circleci: build_docs Your tests passed on CircleCI!
Details
codecov/patch Coverage not affected when comparing 7803aad...057d5ed
Details
codecov/project 72.1% (target 0%)
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.