Updated CONTRIBUTION Guide

[thealphacod3r]

Fixes #168
@seanpmorgan sir, Please review this!!

If any more changes can be done please point it out!!

[review-notebook-app]

Check out this pull request on ReviewNB: https://app.reviewnb.com/tensorflow/addons/pull/233

Visit www.reviewnb.com to know how we simplify your Jupyter Notebook workflows.

[seanpmorgan]

Hey @amanp592 thanks for starting this. I think we may have had a mis-communication. What we want to do is update CONTRIBUTING.md to explain to users how to create new examples using colab.

That mostly my fault as I started that issue discussing notebook templates etc.

[thealphacod3r]

@seanpmorgan Sorry for this! i thought it was about notebook template and all, well no worries mistakes happens!

Now coming to the main point what i am getting is the CONTRIBUTING.md needs to be updated to how to create new examples using colab but currently there are jupyter notebooks with links to colab then what's the point of creating new examples in colab?

Do you want the examples notebook to be colab notebooks and remove all jupyter notebooks and to be converted into colab notebooks??

Please correct me if i am wrong anywhere!!

[seanpmorgan]

@amanp592 No worries at all, we can always iterate. So if you create a colab notebook there is a Save to Github option. That is how you can build and test your example on colab and then save the notebook to a branch you have created. The information should be in the example template on tensorflow docs.

[thealphacod3r]

@seanpmorgan Thankyou,

Now i understood so final words,

Update the CONTRIBUTION.md so that the user will understand that how they can create examples in Colab and save the file in github and specify two more points:

1. reviewNB
2. Colab link issue user should link the notebook present in the tensorflow repository else the link will be broken.

Anything else then please specify!!

[thealphacod3r]

@seanpmorgan I did as you explained.

Please review this and tell me if anything is wrong.

[thealphacod3r]

@seanpmorgan all looks good? or we need to change something???

[seanpmorgan]

Thanks @amanp592 ! I've added some comments but I think we're close.

[seanpmorgan]

I would name this section "Contributing Examples" And then add a small blurb about how all examples are built using colab and then saved as .ipynb files in the repo

[seanpmorgan]

Close! I think the following steps are needed:

1. Create a branch on your fork

2. Goto colab.google.com and start a new notebook using this template:
   https://github.com/tensorflow/docs/blob/master/tools/templates/notebook.ipynb

3. Remove the "View on TensorFlow.org Link"

4. Edit the "View source on Github" and "Run in Google Colab" links so that they point to where the link will reside after it's merged into master (e.g. "https://colab.research.google.com/github/tensorflow/addons/blob/master/examples/layers_weightnormalization.ipynb")

5. Install TF2 and tensorflow-addons
   !pip install tensorflow==2.0.0.a0
   !pip install tensorflow-addons

6. Follow the guidelines of the template

7. Save a copy in github on your branch

[seanpmorgan]

We can probably just remove this line. It's true but it is generally useful for reviewers and not specific to the Dev Environment.

[seanpmorgan]

This issue has gotten a bit stale... see #255 . Thank you very much for the contribution though and it was a great start for the updated PR. Please continue to contribute to the repository!