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

Add a standard README.md template#376

Merged
theadactyl merged 4 commits into
tensorflow:masterfrom
bhack:readme_template
Feb 1, 2022
Merged

Add a standard README.md template#376
theadactyl merged 4 commits into
tensorflow:masterfrom
bhack:readme_template

Conversation

@bhack

@bhack bhack commented Mar 29, 2021

Copy link
Copy Markdown
Contributor

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

bhack commented Mar 29, 2021

Copy link
Copy Markdown
Contributor Author

/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

bhack commented Oct 27, 2021

Copy link
Copy Markdown
Contributor Author

/cc @lamberta for a review

@ematejska

Copy link
Copy Markdown

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

@ematejska

Copy link
Copy Markdown

@theadactyl Can you review?

@qlzh727 qlzh727 left a comment

Copy link
Copy Markdown
Member

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

bhack commented Jan 31, 2022

Copy link
Copy Markdown
Contributor Author

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
Copy Markdown
Contributor

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

@bhack

bhack commented Feb 1, 2022

Copy link
Copy Markdown
Contributor Author

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 subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants