diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 04535605a5..693fc47228 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,6 +47,30 @@ paper and understand how it fits into the TensorFlow community. This process can take longer than typical commit reviews so please bare with us** +## Colab Support + +You can add examples using both Jupyter Notebook and Colab Notebooks. + +Want to add more examples using COLAB? + +Follow this: + +1) Open [Colab](https://colab.research.google.com/) +2) Add a new example in the [addons/examples](https://github.com/tensorflow/addons/tree/master/examples) directory. +Template to write a example can be found [here](https://github.com/tensorflow/docs/blob/master/tools/templates/notebook.ipynb). + +3) Open File->Save a copy in Github. +4) Authorize your Colab with Github. +5) Save it in the desired branch. + +**Note: +Links in colab notebooks have to be written so that they'll be in the right spot in the master branch. + +For example in the PR the user must link to: + +`https://colab.research.google.com/github/tensorflow/addons/blob/master/examples/foo.ipynb` + + ## Development Environment It is recommended that development is done in the latest @@ -100,6 +124,9 @@ bazel test -c opt -k \ All submissions, including submissions by project members, require review. We use Github pull requests for this purpose. +For Visual Diffs we prefer to using [reviewNB](www.reviewnb.com). It Simplifies your Notebook Workflows. + + ## Contributor License Agreement Contributions to this project must be accompanied by a Contributor License