Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.51 KB

commit-issue-pr-guidelines.md

File metadata and controls

41 lines (26 loc) · 1.51 KB
Raw

Commit, Issue & PR guidelines

Commits

For commit messages, we use the format:

<type>(<scope>): <subject> (<github-id>)

For example: feat(core): Set custom transaction source for event processors (#5722).

See commit message format for details.

The Github-ID can be left out until the PR is merged.

Issues

Issues should at least be categorized by package, for example package: Node. Additional labels for categorization can be added, and the Sentry SDK team may also add further labels as needed.

Pull Requests (PRs)

PRs are merged via Squash and merge. This means that all commits on the branch will be squashed into a single commit, and committed as such onto develop.

  • The PR name can generally follow the commit name (e.g. feat(core): Set custom transaction source for event processors)
  • Make sure to rebase the branch on develop before squashing it
  • Make sure to update the commit message of the squashed branch to follow the commit guidelines - including the PR number
  • If you are a Sentry employee, assign yourself to the PR

Please note that we cannot enforce Squash Merge due to the usage of Gitflow (see below). Github remembers the last used merge method, so you'll need to make sure to double check that you are using "Squash and Merge" correctly.

Gitflow

We use Gitflow as a branching model.

For more details, see our Gitflow docs.