Skip to content
This repository was archived by the owner on Jul 10, 2025. It is now read-only.

Commit 407d322

Browse files
committed
Add a standard readme template
1 parent 1f70bcd commit 407d322

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

governance/SIG-readme-template.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
2+
# :framed_picture [SIG Logo](https://github.com/tensorflow/community/tree/master/sigs/logos)
3+
4+
## SIG presentation
5+
A general short description of the Repository/SIG.
6+
7+
## Badges section
8+
Add badges for you repostiroy (pypy, python, gitter, api etc.)
9+
10+
CI/Buid specifc badges
11+
12+
## Project/Repository structure
13+
A repository overiew with a short description of its tree/modularity
14+
15+
## Tensorflow compatibility Matrix
16+
Repository releases compatibility with TF and Python version or (other languages, cuda, etc.)
17+
18+
## Release policy
19+
Describe the release policy:
20+
21+
E.g. A release each Tensorflow release, multiple releases between two Tensorflow releases, etc.
22+
23+
## Installation
24+
Quick instruction on how to install the packaged version of the repository
25+
26+
## Docker
27+
How to start to use the library inside a Docker container.
28+
If the specific repo doesn't maintain its own Docker image we could route the user to install the package inside the Tensorflow official Docker container
29+
30+
## Build from source
31+
Pointer to a specific CONTRIBUTING.md section
32+
33+
## Example
34+
A very minimal inline primer just to quiclky expose the library
35+
36+
## DOCS/API
37+
Link to the Tensorflow web site
38+
39+
## Contributing
40+
Link to the CONTRIBUTING.md
41+
42+
## Support/community
43+
Mailing list/Forum
44+
Gitter
45+
46+
## Extra info
47+
Pleae add any extra info or references to others Markdown files in the specific repo

0 commit comments

Comments
 (0)