Skip to content
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

Merged
merged 4 commits into from
Feb 1, 2022

Conversation

bhack
Copy link
Contributor

@bhack bhack commented Mar 29, 2021

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.

@google-cla google-cla bot added the cla: yes label Mar 29, 2021
@bhack
Copy link
Contributor Author

bhack commented Mar 29, 2021

/cc @theadactyl

@bhack bhack changed the title Add a standard readme template Add a standard Readme.md template Apr 29, 2021
@bhack bhack changed the title Add a standard Readme.md template Add a standard README.md template Apr 29, 2021
@bhack
Copy link
Contributor Author

bhack commented Oct 27, 2021

/cc @lamberta for a review

@ematejska
Copy link
Contributor

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

@ematejska
Copy link
Contributor

@theadactyl Can you review?

Copy link
Member

@qlzh727 qlzh727 left a 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:

  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

@bhack
Copy link
Contributor Author

bhack commented Jan 31, 2022

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?

@bhack bhack marked this pull request as ready for review January 31, 2022 23:22
Quick copy-edit pass
@theadactyl
Copy link
Contributor

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

@bhack
Copy link
Contributor Author

bhack commented Feb 1, 2022

Yes thanks let see how we could promote its adoption.

@theadactyl theadactyl merged commit e94e805 into tensorflow:master Feb 1, 2022
This was referenced Jul 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants