Contributing to the gallery
How to contribute¶
General instructions are available in the main repository, describing in details the tools used to build the project.
There are two ways to contribute specifically to this gallery.
- Adding a notebook in the gallery itself: we suggest to add a directory containing the notebook and any other file needed by the application.
- Linking it from a personal repository in the external notebooks section.
Add a notebook in the gallery¶
- Create a directory under gallery
- add your notebooks in markdown format (have a look at the example)
- add a nice thumbnail into the image directory to represent your application
- add your dependencies to the pyproject.toml file and if needed relock the dependencies
with
make lock
- modify the file index.md to add your card and a link to the notebooks
Add a link to a personal repository¶
- add a nice thumbnail into the image directory to represent your application
- modify the index.md to add your card and a link to the notebooks