From bf22abe3f86862257a8652ecb10a55eeb21b7142 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 21 Feb 2025 11:23:55 +0100 Subject: [PATCH] Add note about conventional commits --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 746e34806a..0bea7c7df5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.