Skip to content

Commit c636ccb

Browse files
committed
Improve development docs
1 parent 48ade31 commit c636ccb

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

DEVELOPMENT.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33
## Setup
44

55
- Install dependencies: `bundle`
6-
- Generate latest client based on OpenAPI spec:
7-
- Install [OpenAPI Generator](https://openapi-generator.tech/), for macOS: `brew install openapi-generator`
8-
- Run `bundle exec rake generate`
6+
- Install [OpenAPI Generator](https://openapi-generator.tech/) (on macOS: `brew install openapi-generator`)
97
- Run tests: `bundle exec rake spec` or `rspec`
108

9+
## Generating
10+
11+
Run `bundle exec rake generate`. This will generate the API client from the latest OpenAPI spec. Once generated, you should open a PR and merge the changes.
12+
1113
## Publishing
1214

1315
Run the "Publish" GitHub Actions workflow

0 commit comments

Comments
 (0)