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

Commit e94e805

Browse files
authored
Merge pull request #376 from bhack/readme_template
Add a standard README.md template
2 parents 7f160b5 + cc89999 commit e94e805

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

governance/SIG-readme-template.md

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

0 commit comments

Comments
 (0)