DOC: Update READMEs (#255)

* DOC: Update READMEs

* Spelling

* Created using Colaboratory

* Update READMEs

* Minor fix grammar

* Add CI testing info

* Spelling

* Reword

* Consistent punctuation

* Fix link

* Finalize doc updates

Author: seanpmorgan

CONTRIBUTING.md

@@ -18,7 +18,9 @@ minor, then feel free to make them without discussion.
 
 Want to contribute but not sure of what? Here are a few suggestions:
 1. Add a new example or tutorial. Located in [`examples/`](examples),
-  these are a great way to familiarize yourself and others with TF-Addons.
+  these are a great way to familiarize yourself and others with TF-Addons. See 
+  [the guidelines](examples/README.md) for more information on how to add 
+  examples.
 2. Solve an [existing issue](https://github.com/tensorflow/addons/issues).
   These range from low-level software bugs to higher-level design problems.
   Check out the label [help wanted](https://github.com/tensorflow/addons/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). If you're a new contributor, the label [good first issue](https://github.com/tensorflow/addons/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) can be a good place to start.
@@ -36,11 +38,7 @@ fitting the following criteria:
 * The addon is impactful to the community (e.g. an implementation used
  in widely cited paper)
  * Lastly, the functionality conforms to the contribution guidelines of
- its API pattern:
-    * [Layers](tensorflow_addons/layers/README.md) |
-      [Optimizers](tensorflow_addons/optimizers/README.md) |
-      [Losses](tensorflow_addons/losses/README.md) |
-      [Custom Ops](tensorflow_addons/custom_ops/README.md)
+ its subpackage.
 
 **Note: New contributions often require team-members to read a research
 paper and understand how it fits into the TensorFlow community. This
@@ -56,25 +54,24 @@ It is recommended that development is done in the latest
 docker run --rm -it -v ${PWD}:/addons -w /addons tensorflow/tensorflow:nightly-custom-op /bin/bash
 ```
 
-Try those commands below:
+Try these commands below:
 
-0. Format codes automatically: `make code-format`
-1. Sanity check: `make sanity-check`
-2. Run unit test: `make unit-test`
-3. All of the above: `make`
+* Format code automatically: `make code-format`
+* Run sanity check: `make sanity-check`
+* Run unit tests: `make unit-test`
+* All of the above: `make`
 
 ## Coding style
 
 Addons provides `make code-format` command to format your changes
-automatically, don't forget to use it before pushing your codes.
+automatically, don't forget to use it before pushing your code.
 
 Please see our [Style Guide](STYLE_GUIDE.md) for more details.
 
 ## Code Testing
 #### CI Testing
-We're in the process of setting up our nightly CI testing. Because this
-project will contain CUDA kernels, we need to make sure that the
-hardware will be available from our CI provider.
+Nighly CI tests are ran and results can be found on the central README. To 
+subscribe for alerts please join the [addons-testing mailing list](https://groups.google.com/a/tensorflow.org/forum/#!forum/addons-testing).
 
 #### Locally Testing
 

README.md

@@ -33,6 +33,7 @@ developments that cannot be integrated into core TensorFlow
 | [tfa.image](tensorflow_addons/image/README.md) | SIG-Addons | @windqaq @facaiy |
 | [tfa.layers](tensorflow_addons/layers/README.md) | SIG-Addons | @seanpmorgan @facaiy |
 | [tfa.losses](tensorflow_addons/losses/README.md) | SIG-Addons | @facaiy @windqaq   |
+| [tfa.metrics](tensorflow_addons/metrics/README.md) | SIG-Addons |  | 
 | [tfa.optimizers](tensorflow_addons/optimizers/README.md) | SIG-Addons | @facaiy @windqaq |
 | [tfa.rnn](tensorflow_addons/rnn/README.md) | Google | @qlzh727 |
 | [tfa.seq2seq](tensorflow_addons/seq2seq/README.md) | Google | @qlzh727 |
@@ -45,12 +46,53 @@ User experience and project maintainability are core concepts in
 TF-Addons. In order to achieve these we require that our additions
 conform to established API patterns seen in core TensorFlow.
 
+#### Proxy Maintainership
+Addons has been designed to compartmentalize subpackages and submodules so 
+that they can be maintained by users who have expertise and a vested interest 
+in that component. 
+
+Subpackage maintainership will only be granted after substantial contribution 
+has been made in order to limit the number of users with write permission. 
+Contributions can come in the form of issue closings, bug fixes, documentation, 
+new code, or optimizing existing code. Submodule maintainership can be granted 
+with a lower barrier for entry as this will not include write permissions to 
+the repo.
+
+For more information see [the RFC](https://github.com/tensorflow/community/blob/master/rfcs/20190308-addons-proxy-maintainership.md) 
+on this topic.
+
 #### Periodic Evaluation of Subpackages
-Based on the nature of this repository, there will be contributions that
-in time become dated and unused. In order to keep the project
-maintainable, SIG-Addons will perform periodic reviews and deprecate
-contributions which will be slated for removal. More information will
-be available after we submit a formal request for comment.
+Given the nature of this repository, subpackages and submodules may become less 
+and less useful to the community as time goes on. In order to keep the 
+repository sustainable, we'll be performing bi-annual reviews of our code to 
+ensure everything still belongs within the repo. Contributing factors to this 
+review will be:
+
+1. Number of active maintainers
+2. Amount of OSS use
+3. Amount of issues or bugs attributed to the code
+4. If a better solution is now available
+
+Functionality within TensorFlow Addons can be categorized into three groups:
+
+* **Suggested**: well-maintained API; use is encouraged.
+* **Discouraged**: a better alternative is available; the API is kept for 
+historic reasons; or the API requires maintenance and is the waiting period 
+to be deprecated.
+* **Deprecated**: use at your own risk; subject to be deleted.
+
+The status change between these three groups is: 
+Suggested <-> Discouraged -> Deprecated.
+
+The period between an API being marked as deprecated and being deleted will be 
+90 days. The rationale being:
+
+1. In the event that TensorFlow Addons releases monthly, there will be 2-3 
+releases before an API is deleted. The release notes could give user enough 
+warning.
+
+2. 90 days gives maintainers ample time to fix their code.
+
 
 ## Examples
 See [`examples/`](examples/)

examples/README.md

@@ -0,0 +1,21 @@
+# TensorFlow Addons Examples
+
+TensorFlow Addons welcomes and highly encourages example contributions.
+
+
+## How To Contribute
+
+Addons examples are created using [Google Colab](https://colab.research.google.com/) 
+and the jupyter notebooks are saved to this directory in the repository. To do 
+this, follow the below steps:
+
+1. Create a new branch on your fork of TensorFlow Addons
+2. Goto [Google Colab](https://colab.research.google.com/) and start a new 
+notebook using addons example template:
+[examples/template.ipynb](template.ipynb)
+3. Edit the the links for the "View source on GitHub" and "Run in Google Colab" 
+URL boxes so that they match the name of your new example notebook
+4. Follow the guidelines of the template
+5. "Save a copy in Github" and select your new branch. The notebook should be 
+named `subpackage_submodule`
+6. Submit the branch as a PR on the TF-Addons Github