Skip to content

Commit 3fc3147

Browse files
committed
chore: update CONTRIBUTING.md with conventional commits guidelines
1 parent 2976822 commit 3fc3147

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,11 @@ 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. The release process handles that.
36-
2. Ensure `make validate` passes.
37-
3. The go tests run against the last generated go client. These must pass before making a release.
38-
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.
35+
1. Make sure your PR title and commits follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) spec.
36+
2. Don't bump the version number for `swagger.yml` changes. The release process handles that.
37+
3. Ensure `make validate` passes.
38+
4. The go tests run against the last generated go client. These must pass before making a release.
39+
5. 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.
3940

4041
## Making a new release
4142

0 commit comments

Comments
 (0)