Skip to content

Commit

Permalink
docs: update releases and contributing sections (#345)
Browse files Browse the repository at this point in the history
While working on other stuff I realised these sections have some silly
mistakes and still mention Semantic Pull Request which we've not used in
a while so I decided to clean them up
  • Loading branch information
G-Rath authored Nov 11, 2024
1 parent 0819a9c commit 3976af4
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,20 +196,21 @@ new major versions.
### Releasing

Releases are handled using
[semantically](https://github.com/semantic-release/semantic-release).
[semantic release](https://github.com/semantic-release/semantic-release), which
is run on `main` and releases versions based on
[the commit messages](https://semantic-release.gitbook.io/semantic-release#commit-message-format).

#### Contributing

This repo uses
[convectional commits](https://www.conventionalcommits.org/en/v1.0.0/) to enable
semantic releases & changelog generation.
[conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) to enable
semantic releases & changelog generation, which requires that commits on the
`main` branch follow that format.

When making a PR, `Semantic Pull Request` will check if the PR will trigger a
release, based on the title & commits in the PR.
As we squash our pull requests when merging by default, you should ideally use
title your pull requests using the conventional commit format since that will be
used as the commit message for the squashed commit.

This is done via a status check, which will pass if a release would be triggered
by merging. _You are can merge regardless of if this status check passes or
not._

Please keep in mind that if you're denoting a release via the PRs title, you
will have to squashed. `SPR` will inform you if you should merge or squash.
We run `commitlint` on pull requests to ensure that commit messages follow the
format - while not strictly required when the commits will be squashed, it can
help ensure you're following the format correctly.

0 comments on commit 3976af4

Please sign in to comment.