Merge branch 'main' into feat/cucumber-bump

open-telemetry · Dec 1, 2023 · 94d25c6 · 94d25c6
2 parents 01ff381 + 4ca1862
commit 94d25c6
Show file tree

Hide file tree

Showing 13 changed files with 329 additions and 1,290 deletions.
diff --git a/.commitlintrc.yml b/.commitlintrc.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -42,16 +42,9 @@ for general practices for OpenTelemetry project.
 
 #### Conventional commit
 
-The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages. You can see examples [here](https://www.conventionalcommits.org/en/v1.0.0-beta.4/#examples).
-We use [commitlint](https://github.com/conventional-changelog/commitlint) and [husky](https://github.com/typicode/husky) to prevent bad commit message.
-For example, you want to submit the following commit message `git commit -s -am "my bad commit"`.
-You will receive the following error :
+The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages. You can see examples [here](https://www.conventionalcommits.org/en/v1.0.0/#examples).
 
-```text
-✖   type must be one of [ci, feat, fix, docs, style, refactor, perf, test, revert, chore] [type-enum]
-```
-
-Here an example that will pass the verification: `git commit -s -am "chore(opentelemetry-core): update deps"`
+We use [the "pr-title" CI workflow](./.github/workflows/pr-title.yml) to ensure PR titles, and hence the commit message from those PRs, follow the Conventional Commits spec.
 
 ### Fork