Skip to content
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.

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

Add a standard README.md template #376

Merged
merged 4 commits into from
Feb 1, 2022
Merged
Changes from all commits
Commits
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
46 changes: 46 additions & 0 deletions governance/SIG-readme-template.md
Original file line number Diff line number Diff line change
@@ -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