Skip to content

Updated CONTRIBUTION Guide #233

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.

Sign up for GitHub

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

Closed
wants to merge 5 commits into from
Closed

Updated CONTRIBUTION Guide #233

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
093ed45
Deleted CONTRIBUTING.md
May 2, 2019
a93df74
Added Contributing.ipynb
May 2, 2019
8f2cbf3
Updated some links
May 2, 2019
b9fcd03
Updated CONTRIBUTING.md
May 4, 2019
f60ad87
Deleted CONTRIBUTING.ipynb
May 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

@seanpmorgan seanpmorgan May 7, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


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.
Copy link
Member

@seanpmorgan seanpmorgan May 7, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


**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
Expand Down Expand Up @@ -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.
Copy link
Member

@seanpmorgan seanpmorgan May 7, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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



## Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License
Expand Down