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

Writing a notebook contribution guide #328

Open
kolibril13 opened this issue Oct 30, 2021 · 1 comment
Open

Writing a notebook contribution guide #328

kolibril13 opened this issue Oct 30, 2021 · 1 comment

Comments

@kolibril13
Copy link
Contributor

As discussed in #321, it is desired to keep the jupyter notebooks clean for version control.
Therefore, a contribution Guide for the notebooks could be written.
This guide could also be in form of a notebook and live at https://simpleitk-notebooks.readthedocs.io/.
Things that come into my mind for notebooks right now:

  • They should get formatted by the black formatter.
  • Metadata and empty cells should be cleaned by nbstripout Python/*.ipynb --strip-empty-cells
@zivy
Copy link
Member

zivy commented Oct 31, 2021

There already is a contribution guide. It should be updated with these two points which have been recently added.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants