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

docs: add .readme-metadata.json and generate new README.md #595

Merged
merged 5 commits into from
Apr 2, 2019

Conversation

bcoe
Copy link
Contributor

@bcoe bcoe commented Mar 29, 2019

This pull request introduces the .repo-metadata.json, which @busunkim96 has been working on defining, and re-generates our README based on it.

  • Tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

this isn't quite ready yet, we need to figure out how we're getting a bit more information for samples READMEs.

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Mar 29, 2019
@bcoe bcoe requested review from busunkim96 and jkwlui March 29, 2019 20:39
@codecov
Copy link

codecov bot commented Mar 29, 2019

Codecov Report

Merging #595 into master will decrease coverage by 0.09%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##           master     #595     +/-   ##
=========================================
- Coverage   92.07%   91.97%   -0.1%     
=========================================
  Files          25       25             
  Lines        2057     2057             
  Branches      167      167             
=========================================
- Hits         1894     1892      -2     
- Misses        142      144      +2     
  Partials       21       21
Impacted Files Coverage Δ
dev/src/watch.ts 98.21% <0%> (-0.9%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 88dd4f0...d0842ee. Read the comment docs.

@codecov
Copy link

codecov bot commented Mar 29, 2019

Codecov Report

Merging #595 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #595   +/-   ##
=======================================
  Coverage   92.07%   92.07%           
=======================================
  Files          25       25           
  Lines        2057     2057           
  Branches      167      167           
=======================================
  Hits         1894     1894           
  Misses        142      142           
  Partials       21       21

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 88dd4f0...4eeb08f. Read the comment docs.

@bcoe bcoe changed the title docs: add .readme-metadata.json and generate new README.md [WIP] docs: add .readme-metadata.json and generate new README.md Mar 29, 2019
@bcoe bcoe changed the title [WIP] docs: add .readme-metadata.json and generate new README.md docs: add .readme-metadata.json and generate new README.md Apr 2, 2019
@bcoe bcoe requested a review from callmehiphop April 2, 2019 00:48
@bcoe
Copy link
Contributor Author

bcoe commented Apr 2, 2019

@callmehiphop @busunkim96 @jkwlui this pull should now be ready for review.


View the [source code](https://github.com/googleapis/nodejs-firestore/blob/master/samples/quickstart.js).

[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-firestore&page=editor&open_in_editor=samples/quickstart.js,samples/README.md)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

after discussion with @JustinBeckwith last week, we opted to significantly simplify the samples README.md, until we can pull in more information from DRIFT.

@JustinBeckwith JustinBeckwith merged commit cf98949 into master Apr 2, 2019
@schmidt-sebastian schmidt-sebastian deleted the meta-info branch July 3, 2019 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants