From 8c01b7f05a16006e59b1ee0c3b102493f49b8cff Mon Sep 17 00:00:00 2001 From: Ben Browning Date: Thu, 13 Feb 2025 10:57:30 -0500 Subject: [PATCH] docs: Mention convential commits format in CONTRIBUTING.md (#1075) # What does this PR do? This adds a note to ensure pull requests follow the conventional commits format, along with a link to that format, in CONTRIBUTING.md. One of the pull-request checks enforces PR titles that match this format, so it's good to be upfront about this expectation before a new developer opens a PR. Signed-off-by: Ben Browning --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8028c194e..6dc08b5c0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,6 +40,7 @@ If you need help or guidance, comment on the issue. Issues that are extra friend 3. Ensure the test suite passes. 4. Make sure your code lints using `pre-commit`. 5. If you haven't already, complete the Contributor License Agreement ("CLA"). +6. Ensure your pull request follows the [conventional commits format](https://www.conventionalcommits.org/en/v1.0.0/). ## Contributor License Agreement ("CLA") In order to accept your pull request, we need you to submit a CLA. You only need