Skip to content

Commit

Permalink
docs: Update CONTRIBUTING.md (#317)
Browse files Browse the repository at this point in the history
Co-authored-by: Johannes Vogel <31311694+johannes-vogel@users.noreply.github.com>
  • Loading branch information
patricebender and johannes-vogel authored Oct 31, 2023
1 parent 7896289 commit 2ce4793
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,18 @@ The `type` can be any of `feat`, `fix` or `chore`.

The prefix is used to calculate the semver release level, and the section of the release notes to place the commit message in.

| **type** | when to use | release level | release note section |
| --------- | ----------------------------------- | ------------- | -------------------- |
| feat | a feature has been added | `minor` | **Features** |
| fix | a bug has been patched | `patch` | **Bug fixes** |
| chore | any changes that aren't user-facing | none | none |
| **type** | When to Use | Release Level | Release Note Section |
| ---------- | ----------------------------------- | ------------- | -------------------- |
| feat | A feature has been added | `minor` | **Added** |
| fix | A bug has been patched | `patch` | **Fixed** |
| deps | Changes to the dependencies | `patch` | **Changed** |
| perf | Performance improvements | none | **Performance Improvements** |
| chore | Any changes that aren't user-facing | none | none |
| docs | Documentation updates | none | none |
| style | Code style and formatting changes | none | none |
| refactor | Code refactoring | none | none | |
| test | Adding tests or test-related changes| none | none |
| build | Build system or tooling changes | none | none |
| ci | Continuous Integration/Deployment | none | none |
| revert | Reverting a previous commit | none | none |
| wip | Work in progress (temporary) | none | none |

0 comments on commit 2ce4793

Please sign in to comment.