Skip to content

Latest commit

 

History

History
17 lines (12 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

17 lines (12 loc) · 1.71 KB

Contributing

  1. Check out a feature branch, and, if relevant, open an issue and/or a draft PR.
  2. Create one or more notebooks, either in the top level of this repository (for a single-notebook tutorial) or in a subdirectory (for a tutorial with one or more notebooks).
  3. If a notebook has any requirements that aren't already included in this repository's requirements.txt, add them to that file.
  4. If any of the output cells in a notebook are too long, edit the JSON in the raw *.ipynb file to abridge or truncate the overlong output(s) to reduce the file size and emphasize the relevant portion(s) of the output. For example, several sections of this output are replaced with […].
  5. If you want the tutorial to appear in the user docs, add it to the TOC tree in index.rst
  6. (optionally), add a download link to the top of your notebook.