Skip to content

Commit

Permalink
Merge pull request #661 from molgenis/docs/update-contributing-commit…
Browse files Browse the repository at this point in the history
…-msgs

docs(CONTRIBUTING.md): clarify use of commit messages
  • Loading branch information
marikaris authored Feb 26, 2024
2 parents 23272d2 + 03c81f3 commit 979b50e
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,21 +57,27 @@ We have several components

## Releasing

We release through [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) which autoincrement using [Semantic versioning](https://semver.org/).
Releases are done whenever the versionnumber gets bumped. For more information see the `Commit messages and versioning (Major, Minor, Patch updates)` section below.

We use mooltiverse [Nyx](https://mooltiverse.github.io/nyx/guide/user/introduction/how-nyx-works/) for changelog and publishing to github.

Run `./gradlew tasks --group Release` to see all release tasks

Use `./gradlew nyxMake` to see what is build in [build/distributions](./build/distributions/).

### Major, Minor, Patch updates
### Commit messages and versioning (Major, Minor, Patch updates)

Each commit with `!` just before the color `:` is a major update. So use it wisely. You can also add `BREAKING CHANGE:` in the long commit message format.
Versionnumbers are updated according to [Semantic versioning](https://semver.org/), using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).

- Use `feat!: ...` or `fix!: ...` for a major upgrade
- Use `feat: ...` for a minor upgrade
- Use `fix: ...` for a patch update
Please be aware that only new releases will be done when one of the above prefixes is used.

Other prefixes do not indicate user-facing changes and will therefore not result in a version bump, consequently not resulting in a new (pre) release.

Each commit with `!` just before the colon `:` is a major update, indicating a breaking change. So use it wisely. You can also add `BREAKING CHANGE:` in the long commit message format.

- Use `feat!: ...` or `fix!: ...` for a major upgrade, indicating a breaking change.
- Use `feat: ...` for a minor upgrade, indicating a new feature.
- Use `fix: ...` for a patch update, indicating a bugfix.

### Checking log messages

Expand Down

0 comments on commit 979b50e

Please sign in to comment.