Skip to content

Commit 08c5974

Browse files
committed
docs(contributing): improve wording (#696)
1 parent 6175eca commit 08c5974

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This repository uses [`yarn@v1`](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable).
44
Other package managers may work but are not officially supported for development.
55

6-
To setup the repository, run:
6+
To set up the repository, run:
77

88
```bash
99
yarn
@@ -65,7 +65,7 @@ pnpm link -—global openai
6565

6666
## Running tests
6767

68-
Most tests will require you to [setup a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
68+
Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
6969

7070
```bash
7171
npx prism path/to/your/openapi.yml
@@ -99,7 +99,7 @@ the changes aren't made through the automated pipeline, you may want to make rel
9999

100100
### Publish with a GitHub workflow
101101

102-
You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/openai/openai-node/actions/workflows/publish-npm.yml). This will require a setup organization or repository secret to be set up.
102+
You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/openai/openai-node/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up.
103103

104104
### Publish manually
105105

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -424,7 +424,7 @@ import OpenAI from 'openai';
424424
```
425425

426426
To do the inverse, add `import "openai/shims/node"` (which does import polyfills).
427-
This can also be useful if you are getting the wrong TypeScript types for `Response` more details [here](https://github.com/openai/openai-node/tree/master/src/_shims#readme).
427+
This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/openai/openai-node/tree/master/src/_shims#readme)).
428428

429429
You may also provide a custom `fetch` function when instantiating the client,
430430
which can be used to inspect or alter the `Request` or `Response` before/after each request:

0 commit comments

Comments
 (0)