Skip to content

Commit 90cb30d

Browse files
docs: update contributing instructions (#234)
* changes without context autosynth cannot find the source of changes triggered by earlier changes in this repository, or by version upgrades to tools such as linters. * docs: add instructions for authenticating for system tests * docs: add instructions for authenticating for system tests * docs: add phrasing change to README Source-Author: sofisl <55454395+sofisl@users.noreply.github.com> Source-Date: Mon Dec 21 13:21:29 2020 -0800 Source-Repo: googleapis/synthtool Source-Sha: 363fe305e9ce34a6cd53951c6ee5f997094b54ee Source-Link: googleapis/synthtool@363fe30
1 parent 9e7e3e7 commit 90cb30d

3 files changed

Lines changed: 15 additions & 5 deletions

File tree

packages/google-cloud-phishingprotection/CONTRIBUTING.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,15 @@ accept your pull requests.
3737
1. Title your pull request following [Conventional Commits](https://www.conventionalcommits.org/) styling.
3838
1. Submit a pull request.
3939

40+
### Before you begin
41+
42+
1. [Select or create a Cloud Platform project][projects].
43+
1. [Enable billing for your project][billing].
44+
1. [Enable the Phishing Protection API][enable_api].
45+
1. [Set up authentication with a service account][auth] so you can access the
46+
API from your local workstation.
47+
48+
4049
## Running the tests
4150

4251
1. [Prepare your environment for Node.js setup][setup].
@@ -51,15 +60,17 @@ accept your pull requests.
5160
npm test
5261

5362
# Run sample integration tests.
54-
gcloud auth application-default login
5563
npm run samples-test
5664

5765
# Run all system tests.
58-
gcloud auth application-default login
5966
npm run system-test
6067

6168
1. Lint (and maybe fix) any changes:
6269

6370
npm run fix
6471

6572
[setup]: https://cloud.google.com/nodejs/docs/setup
73+
[projects]: https://console.cloud.google.com/project
74+
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
75+
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=phishingprotection.googleapis.com
76+
[auth]: https://cloud.google.com/docs/authentication/getting-started

packages/google-cloud-phishingprotection/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,7 @@ console.info(`reported ${uri} to Phishing Protection API`);
8080

8181
## Samples
8282

83-
Samples are in the [`samples/`](https://github.com/googleapis/nodejs-phishing-protection/tree/master/samples) directory. The samples' `README.md`
84-
has instructions for running the samples.
83+
Samples are in the [`samples/`](https://github.com/googleapis/nodejs-phishing-protection/tree/master/samples) directory. Each sample's `README.md` has instructions for running its sample.
8584

8685
| Sample | Source Code | Try it |
8786
| --------------------------- | --------------------------------- | ------ |

packages/google-cloud-phishingprotection/synth.metadata

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"git": {
2020
"name": "synthtool",
2121
"remote": "https://github.com/googleapis/synthtool.git",
22-
"sha": "15013eff642a7e7e855aed5a29e6e83c39beba2a"
22+
"sha": "363fe305e9ce34a6cd53951c6ee5f997094b54ee"
2323
}
2424
}
2525
],

0 commit comments

Comments
 (0)