|
40 | 40 | - `src/lib/` - Core functionality |
41 | 41 | - `src/bin/` - CLI entry points |
42 | 42 | - `src/mocks/` - Test mocks |
| 43 | + |
| 44 | +## Commit Message Guidelines |
| 45 | + |
| 46 | +Versions of this software are automatically determined by `semantic-release`. Follow |
| 47 | +`conventionalcommits.org` standard, specifically the `@commitlint/config-conventional` |
| 48 | +format. |
| 49 | + |
| 50 | +- `feat: msg`: features |
| 51 | +- `fix: msg`: bug fixes |
| 52 | +- `refactor: msg`: code improvements that do not affect functionality |
| 53 | +- `test: msg`: changes in tests only, does not affect functionality |
| 54 | +- `docs: msg`: changes to documentation |
| 55 | +- `ci: msg`: build pipeline |
| 56 | +- `chore: msg`: updating dependencies, miscellany |
| 57 | +- Breaking changes to exposed APIs surfaces must be documented with a footer/trailer. For |
| 58 | + example: |
| 59 | + |
| 60 | + ``` |
| 61 | + feat: remove the `POST /api/spline/reticulate` endpoint |
| 62 | +
|
| 63 | + BREAKING CHANGE: Support for previously deprecated spline reticulation |
| 64 | + has been removed. Use `POST /api/spline/frobnicate` instead. |
| 65 | + ``` |
| 66 | + |
| 67 | +- Scopes may also be used: |
| 68 | + - `feat(ui): increase button roundness` |
| 69 | + - `docs(readme): add frobnication section` |
| 70 | + - `chore(dev-deps): update dev dependencies` |
| 71 | + - `chore(deps): update dependencies` |
| 72 | + |
| 73 | +Only certain commit messages will trigger changes to the semantic version of the software: |
| 74 | + |
| 75 | +- A breaking change will trigger a major version bump, regardless of the prefix |
| 76 | +- The `feat` prefix bumps the minor version |
| 77 | +- The `fix` prefix bumps the patch version |
| 78 | +- All other commit messages have no effect on the version |
0 commit comments