Skip to content

docs: mandate conventional commits in PR titles #482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tigarmo merged 1 commit into from
Jan 27, 2026
Merged

docs: mandate conventional commits in PR titles #482

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,10 +321,14 @@ Once your work is committed to your branch, push it to your fork:
git push -u origin <branch-name>
```

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

Expand Down