@@ -5,17 +5,29 @@ TensorFlow I/O welcomes and highly encourages tutorial contributions.
5
5
6
6
## How To Contribute
7
7
8
- I/O tutorials are created using [ Google Colab] ( https://colab.research.google.com/ )
9
- and the jupyter notebooks are saved to this directory in the repository. To do
8
+ I/O tutorials are created using [ Google Colab] ( https://colab.research.google.com/ )
9
+ and the jupyter notebooks are saved to this directory in the repository. To do
10
10
this, follow the below steps:
11
11
12
- 1 . Create a new branch on your fork of TensorFlow I/O
13
- 2 . Goto [ Google Colab] ( https://colab.research.google.com/ ) and start a new
12
+ 1 . Create a new branch on your fork of TensorFlow I/O.
13
+ 2 . Goto [ Google Colab] ( https://colab.research.google.com/ ) and start a new
14
14
notebook using addons example template:
15
- [ notebook template] ( https://github.com/tensorflow/docs/blob/master/tools/templates/notebook.ipynb )
16
- 3 . Edit the the links for the "View source on GitHub" and "Run in Google Colab"
17
- URL boxes so that they match the name of your new example notebook
18
- 4 . Follow the guidelines of the template
19
- 5 . "Save a copy in Github" and select your new branch. The notebook should be
20
- named ` subpackage_submodule `
21
- 6 . Submit the branch as a PR on the TF-I/O [ Github] ( https://github.com/tensorflow/io )
15
+ [ notebook template] ( https://github.com/tensorflow/docs/blob/master/tools/templates/notebook.ipynb ) .
16
+ 3 . Edit the the links for the "View source on GitHub" and "Run in Google Colab"
17
+ URL boxes so that they match the name of your new example notebook.
18
+ 4 . Follow the guidelines of the template.
19
+ 5 . "Save a copy in Github" and select your new branch. The notebook should be
20
+ named ` subpackage_submodule ` .
21
+ 6 . After step 5, the notebook will be committed to your branch directly from colab.
22
+ However, to check for linting issues and to auto format your notebook, pull the changes to your system
23
+ and run the following from the ` io ` directory:
24
+ ```console
25
+ $ sudo python3 -m pip install setuptools
26
+ $ sudo python3 -m pip install -U git+https://github.com/tensorflow/docs
27
+ $ echo "Auto format the notebooks: "
28
+ $ find docs -name '* .ipynb' | xargs python3 -m tensorflow_docs.tools.nbfmt
29
+ $ echo "Check for failed lint: "
30
+ $ find docs -name '* .ipynb' | xargs python3 -m tensorflow_docs.tools.nblint --arg=repo: tensorflow /io
31
+ ```
32
+ 7 . Update ` docs/tutorials/_toc.yaml ` with the notebook details (please refer existing entries).
33
+ 8 . Submit the branch as a PR on the TF-I/O [ Github] ( https://github.com/tensorflow/io )
0 commit comments