-
Notifications
You must be signed in to change notification settings - Fork 22
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
Add notebook guidelines #316
Conversation
Codecov Report
@@ Coverage Diff @@
## main #316 +/- ##
=======================================
Coverage 91.78% 91.78%
=======================================
Files 43 43
Lines 2324 2324
=======================================
Hits 2133 2133
Misses 191 191
Flags with carried forward coverage won't be shown. Click here to find out more. 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Recommend adding a policy around link-out to documentation. Most notebooks would be more useful if they copiously link to supporting docs (e.g., API), but also may then require ongoing link maintenance as docs evolve.
Otherwise LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, with a few typos to correct.
Should this also specify:
- Results should be run/rendered in the notebook
- Notebooks should be runnable on instances of type T (CPU/mem), not taking more than M minutes.
- Code formatting must pass lint requirements (we get this automatically, but still, it's a policy)
- Python version min/max
- Must only use packages listed requirements-notebooks.txt
Co-authored-by: Andrew Tolopko <[email protected]>
Co-authored-by: Andrew Tolopko <[email protected]>
Co-authored-by: Andrew Tolopko <[email protected]>
These will live in doc-site and should mainly be accessed through doc-site, no user-facing docs should link to the notebooks in the repo. Adding the doc-site link will be redundant |
Adds a document with a set of editorial guidelines for notebooks (python) and vignettes (R).
An audit of the existing assets must follow upon approval of this PR.