Skip to content

Commit

Permalink
Improve development docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bradymholt committed Dec 31, 2024
1 parent 48ade31 commit c636ccb
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@
## Setup

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

## Generating

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.

## Publishing

Run the "Publish" GitHub Actions workflow
Expand Down

0 comments on commit c636ccb

Please sign in to comment.