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

Commit cc89999

Browse files
authored
Update SIG-readme-template.md
Quick copy-edit pass
1 parent 9827d03 commit cc89999

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

governance/SIG-readme-template.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,46 @@
11

22
# :framed_picture: [SIG Logo](https://github.com/tensorflow/community/tree/master/sigs/logos)
33

4-
## SIG presentation
5-
A general short description of the Repository/SIG.
4+
## SIG description
5+
A short overview of the SIG goals & scope.
66

77
## Example
8-
A very minimal inline primer just to quiclky expose the library
8+
A minimal inline primer to quickly expose the library
99

10-
## DOCS/API
11-
Link to the Tensorflow web site
10+
## Docs/API
11+
Link to the appropriate Tensorflow web site page (if applicable)
1212

13-
## Badges section
14-
Add badges for you repostiroy (pypy, python, gitter, api etc.)
15-
CI/Buid specifc badges
13+
## Badges
14+
Add badges for you repository (pypy, python, gitter, api etc.)
15+
CI/Buid specific badges
1616

17-
## Tensorflow compatibility Matrix
18-
Repository releases compatibility with TF and Python version or (other languages, cuda, etc.)
17+
## TensorFlow compatibility Matrix
18+
Releases compatibility with TF and Python versions or (other languages, cuda, etc.)
1919

2020
## Project/Repository structure
2121
A repository overiew with a short description of its tree/modularity
2222

2323
## Release policy
2424
Describe the release policy:
2525

26-
E.g. A release each Tensorflow release, multiple releases between two Tensorflow releases, etc.
26+
E.g. A release for each Tensorflow release, multiple releases between two Tensorflow releases, etc.
2727

2828
## Installation
2929
Quick instruction on how to install the packaged version of the repository
3030

3131
## Docker
32-
How to start to use the library inside a Docker container.
33-
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
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.
3434

3535
## Build from source
3636
Pointer to a specific CONTRIBUTING.md section
3737

3838
## Contributing
3939
Link to the CONTRIBUTING.md
4040

41-
## Support/community
41+
## Support/Community
4242
Mailing list/Forum
4343
Gitter
4444

4545
## Extra info
46-
Pleae add any extra info or references to others Markdown files in the specific repo
46+
Please add any extra info or references to important Markdown files or resources in the repo

0 commit comments

Comments
 (0)