Improve contributor onboarding document (README/CONTRIBUTING/Dev notes) #95
Closed
butchtm
started this conversation in
Enhancements Requests
Replies: 1 comment
-
|
Addressed by #243 |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Centralize the placement of the instructions and clarify the steps for onboarding new contributors:
- Forking and cloning the repo (including syncing updates after the fork)
- Setting up a local jupyter notebook dev
- (optionally) Setting up jekyll for local doc site and viewing the updated docs locally
- Making changes to the jupyter notebooks (and updating the code modules)
- Checking that the modifications pass the project requirements (formatting, linting, unit tests, notebook tests)
- Pushing changes back to the repo and making a PR
Beta Was this translation helpful? Give feedback.
All reactions