search

tensorflow / community

Stores documents used by the TensorFlow developer community
Apache License 2.0
1.26k stars 580 forks source link

Add a standard README.md template #376

Closed bhack closed 2 years ago

bhack commented 3 years ago

This is a Draft README.md template. It is part of an effort to standardize some early access info for Github community health files across the TensorFlow ecosystem repositories.

bhack commented 3 years ago

/cc @theadactyl

bhack commented 3 years ago

/cc @lamberta for a review

ematejska commented 2 years ago

@bhack Is this ready for review or still a draft?

ematejska commented 2 years ago

@theadactyl Can you review?

bhack commented 2 years ago

I think this is great start. Order wise, I think we should put more important information up front:

1. short description

2. example and API docs

3. build status and release/version compat information.

4. Finally anything related to contribution, repo structure, installation guide, build instruction, and contribution.md

Can you check now?

theadactyl commented 2 years ago

@bhack assuming you are fine with my changes, this is ready to be merged. Thanks for your work!

bhack commented 2 years ago

Yes thanks let see how we could promote its adoption.