Skip to content

docs(engineering-practices): Correct minor issues in commit guidelines #16625

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

Open
adeleroi wants to merge 2 commits into
base: master
Choose a base branch
from
+3 −3
Open

docs(engineering-practices): Correct minor issues in commit guidelines #16625

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a5ae2a
docs(engineering-practices): Correct minor grammar issues in commit m…
wilfrie Mar 1, 2026
fb392eb
Merge branch 'master' into docs/commit-guidelines-grammar
adeleroi Mar 2, 2026
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
6 changes: 3 additions & 3 deletions develop-docs/engineering-practices/commit-messages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ sidebar_order: 10

### Merge vs Rebase

Sentry uses a rebase workflow. That means that every commit on its own should be a clear, functional, and stable change. This means then when you’re building a new feature, you should try to pare it down into functional steps, and when that’s not reasonable, the end patch should be a single commit. This is counter to having a Pull Request which may include “fix [unmerged] behavior”. Those commits should be squashed, and the final patch when landed should be rebased.
Sentry uses a rebase workflow. That means that every commit on its own should be a clear, functional, and stable change. This means that when you’re building a new feature, you should try to pare it down into functional steps, and when that’s not reasonable, the end patch should be a single commit. This is counter to having a Pull Request which may include “fix [unmerged] behavior”. Those commits should be squashed, and the final patch when landed should be rebased.

Remember: each commit should follow the commit message format and be stable (green build).

#### Rebase and Merge

The GitHub UI exposes a “Rebase and Merge” option, which, if your commits are already in following the commit guidelines, is a great way to bring your change into the codebase.
The GitHub UI exposes a “Rebase and Merge” option, which, if your commits already follow the commit guidelines, is a great way to bring your change into the codebase.

#### Squashing

Expand All @@ -46,7 +46,7 @@ The header has a special format that includes a type, a scope and a subject:

The **header** is mandatory and the **scope** of the header is optional. If you have a Jira issue to link to, add the **jira-id** the commit belongs to. This helps to connect changes back to Jira tickets.

Any line of the commit message should not be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
Any line of the commit message should not be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

The footer should contain a closing reference to an issue as well as a relevant Sentry issue if any.

Expand Down