diff --git a/governance/SIG-readme-template.md b/governance/SIG-readme-template.md new file mode 100644 index 000000000..880e8553f --- /dev/null +++ b/governance/SIG-readme-template.md @@ -0,0 +1,46 @@ + +# :framed_picture: [SIG Logo](https://github.com/tensorflow/community/tree/master/sigs/logos) + +## SIG description +A short overview of the SIG goals & scope. + +## Example +A minimal inline primer to quickly expose the library + +## Docs/API +Link to the appropriate Tensorflow web site page (if applicable) + +## Badges +Add badges for you repository (pypy, python, gitter, api etc.) +CI/Buid specific badges + +## TensorFlow compatibility Matrix +Releases compatibility with TF and Python versions or (other languages, cuda, etc.) + +## Project/Repository structure +A repository overiew with a short description of its tree/modularity + +## Release policy +Describe the release policy: + +E.g. A release for each Tensorflow release, multiple releases between two Tensorflow releases, etc. + +## Installation +Quick instruction on how to install the packaged version of the repository + +## Docker +How to use the library inside a Docker container. +If the specific repo doesn't maintain its own Docker image, consider directing users to install the package inside the Tensorflow official Docker container. + +## Build from source +Pointer to a specific CONTRIBUTING.md section + +## Contributing +Link to the CONTRIBUTING.md + +## Support/Community +Mailing list/Forum +Gitter + +## Extra info +Please add any extra info or references to important Markdown files or resources in the repo