chore: update CONTRIBUTING.md with conventional commits guidelines

netlify · Jan 20, 2021 · 3fc3147 · 3fc3147
1 parent 2976822
commit 3fc3147
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -32,10 +32,11 @@ You may first want to edit swagger.yml to add your field or endpoint definitions
 
 ## Making PRs
 
-1. Don't bump the version number for `swagger.yml` changes. The release process handles that.
-2. Ensure `make validate` passes.
-3. The go tests run against the last generated go client. These must pass before making a release.
-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.
+1. Make sure your PR title and commits follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) spec.
+2. Don't bump the version number for `swagger.yml` changes. The release process handles that.
+3. Ensure `make validate` passes.
+4. The go tests run against the last generated go client. These must pass before making a release.
+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.
 
 ## Making a new release