From 53b8277b3a995d5cb0436afe18b7c9a0c6e54544 Mon Sep 17 00:00:00 2001 From: Michael DuBelko Date: Mon, 26 Jan 2026 15:14:41 -0800 Subject: [PATCH] docs: mandate conventional commits in PR titles --- CONTRIBUTING.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b836df1..37cadeb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -321,10 +321,14 @@ Once your work is committed to your branch, push it to your fork: git push -u origin ``` -Finally, [open a PR](https://github.com/canonical/starbase/compare) for it on GitHub. -If your branch has one commit, GitHub will title the PR after it. If your branch has -more than one commit, name the PR after the most significant. Once open, reviewers are -assigned automatically to your work. +On GitHub, [open a PR](https://github.com/canonical/starbase/compare) for your branch in +Starbase. + +Format the PR title as a conventional commit. If your branch has only one commit, GitHub +handles this automatically. If your branch has multiple commits, copy the title of the +most important one. + +Once open, reviewers are assigned automatically to your work. ### Follow up for the review