-
Notifications
You must be signed in to change notification settings - Fork 577
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
Conversation
/cc @theadactyl |
/cc @lamberta for a review |
@bhack Is this ready for review or still a draft? |
@theadactyl Can you review? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is great start. Order wise, I think we should put more important information up front:
- short description
- example and API docs
- build status and release/version compat information.
- Finally anything related to contribution, repo structure, installation guide, build instruction, and contribution.md
Can you check now? |
Quick copy-edit pass
@bhack assuming you are fine with my changes, this is ready to be merged. Thanks for your work! |
Yes thanks let see how we could promote its adoption. |
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.