Skip to content

Commit

Permalink
Add note about conventional commits
Browse files Browse the repository at this point in the history
  • Loading branch information
scottgerring committed Feb 21, 2025
1 parent ed19c75 commit bf22abe
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,13 @@ Open a pull request against the main
[opentelemetry-rust](https://github.com/open-telemetry/opentelemetry-rust)
repo.

Your pull request should be named according to the
[conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard. This ensures that
when the PR is squashed into `main`, the resulting commit message is consistent and makes it easier
for us to generate a changelog standard. This ensures that
when the PR is squashed into `main`, the resulting commit message is consistent and makes it easier
for us to generate a changelog.

> **Note**
> It is recommended to run [pre-commit script](scripts/precommit.sh) to catch any issues locally.
Expand Down

0 comments on commit bf22abe

Please sign in to comment.