From 540333a89cc643f28e476fb4b98b67fae60ce16d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Thu, 7 Jan 2021 16:34:10 -0800 Subject: [PATCH] docs: update CONTRIBUTING directions (#689) This PR was generated using Autosynth. :rainbow: Synth log will be available here: https://source.cloud.google.com/results/invocations/fc1dd810-ea11-44c0-ab02-fa000827a405/targets - [ ] To automatically regenerate this PR, check this box. Source-Link: https://github.com/googleapis/synthtool/commit/363fe305e9ce34a6cd53951c6ee5f997094b54ee --- packages/google-cloud-speech/CONTRIBUTING.md | 14 ++++++++++++-- packages/google-cloud-speech/README.md | 3 +-- packages/google-cloud-speech/synth.metadata | 5 ++--- 3 files changed, 15 insertions(+), 7 deletions(-) diff --git a/packages/google-cloud-speech/CONTRIBUTING.md b/packages/google-cloud-speech/CONTRIBUTING.md index f6c4cf010e3..6b248c303d2 100644 --- a/packages/google-cloud-speech/CONTRIBUTING.md +++ b/packages/google-cloud-speech/CONTRIBUTING.md @@ -37,6 +37,14 @@ accept your pull requests. 1. Title your pull request following [Conventional Commits](https://www.conventionalcommits.org/) styling. 1. Submit a pull request. +### Before you begin + +1. [Select or create a Cloud Platform project][projects]. +1. [Enable the Cloud Speech API][enable_api]. +1. [Set up authentication with a service account][auth] so you can access the + API from your local workstation. + + ## Running the tests 1. [Prepare your environment for Node.js setup][setup]. @@ -51,11 +59,9 @@ accept your pull requests. npm test # Run sample integration tests. - gcloud auth application-default login npm run samples-test # Run all system tests. - gcloud auth application-default login npm run system-test 1. Lint (and maybe fix) any changes: @@ -63,3 +69,7 @@ accept your pull requests. npm run fix [setup]: https://cloud.google.com/nodejs/docs/setup +[projects]: https://console.cloud.google.com/project +[billing]: https://support.google.com/cloud/answer/6293499#enable-billing +[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=speech.googleapis.com +[auth]: https://cloud.google.com/docs/authentication/getting-started \ No newline at end of file diff --git a/packages/google-cloud-speech/README.md b/packages/google-cloud-speech/README.md index bd17b43b40e..dd986d3b9bb 100644 --- a/packages/google-cloud-speech/README.md +++ b/packages/google-cloud-speech/README.md @@ -96,8 +96,7 @@ quickstart(); ## Samples -Samples are in the [`samples/`](https://github.com/googleapis/nodejs-speech/tree/master/samples) directory. The samples' `README.md` -has instructions for running the samples. +Samples are in the [`samples/`](https://github.com/googleapis/nodejs-speech/tree/master/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | diff --git a/packages/google-cloud-speech/synth.metadata b/packages/google-cloud-speech/synth.metadata index 6331fac9193..d2d116d1930 100644 --- a/packages/google-cloud-speech/synth.metadata +++ b/packages/google-cloud-speech/synth.metadata @@ -4,8 +4,7 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/nodejs-speech.git", - "sha": "76416504d280b0137c60bdfea2ff76b4225db9b7" - } + "sha": "76416504d280b0137c60bdfea2ff76b4225db9b7" } }, { "git": { @@ -19,7 +18,7 @@ "git": { "name": "synthtool", "remote": "https://github.com/googleapis/synthtool.git", - "sha": "15013eff642a7e7e855aed5a29e6e83c39beba2a" + "sha": "363fe305e9ce34a6cd53951c6ee5f997094b54ee" } } ],