Skip to content

Commit 2976822

Browse files
committed
chore: update CONTRIBUTING.md
1 parent b985d27 commit 2976822

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,17 @@ You may first want to edit swagger.yml to add your field or endpoint definitions
3232

3333
## Making PRs
3434

35-
1. Don't bump the version number for `swagger.yml` changes. Do that during the release process.
35+
1. Don't bump the version number for `swagger.yml` changes. The release process handles that.
3636
2. Ensure `make validate` passes.
3737
3. The go tests run against the last generated go client. These must pass before making a release.
3838
4. If all you want is a new endpoint, you can PR just the `swagger.yml` changes for review and regenerate the go client when its ready to go in.
3939

4040
## Making a new release
4141

42-
1. Make sure you are on the HEAD of the master branch.
43-
2. regenarate go client (if you haven't) (Make all and commit the results)
44-
3. bump a JS package version with `npm version [major|minor|patch]` (updates package.json, swagger.yaml and create a git tag)
45-
4. Run `npm publish` which will as `git push && git push --tags` to push to the origin, create a github release and publish the spec to npm.
42+
1. Merge the release PR (auto generated via `release-please`).
43+
2. Switch to the default branch git checkout master.
44+
3. Pull latest changes git pull.
45+
4. Run `npm publish`.
4646

4747
## License
4848

0 commit comments

Comments
 (0)