[MRG] Update the contributer guide #824
Merged
Conversation
This file contains 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
sgibson91
reviewed
Apr 15, 2019
|
Thanks for the ideas. I updated the doc based on your comments. They all got implemented. There is one more thing to discuss (or punt to a later issue): #824 (comment) |
|
Ready to merge. |
|
This pull request has been mentioned on Jupyter Community Forum. There might be relevant details there: https://discourse.jupyter.org/t/should-jupyterhub-and-binderhub-come-in-more-flavors/832/2 |
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.
This changes the contributer documentation around a bit. I was coming back to the project after a bit away wanting to use the contributor guide to quickly figure out how to run tests and got lost.
I think this way of organising them also makes it less intimidating to get started because the first thing isn't "now you need to install minikube and helm". A lot of work can be done without ever touching all that stuff.
It also gets less and less verbose as we progress down the rabbit hole. The assumption is that if you aren't scared of installing minikube and helm you have worked out how to clone a git repository (or can do so). This fixes a pet peeve of mine that a lot of guides are so verbose that you can't find anything if you are using them as a reference. Maybe the solution is to have a guide/howto as part of the documentation and a reference in
CONTRIBUTING.md.