|
| 1 | +# Commit Message Convention |
| 2 | + |
| 3 | +This project uses [Conventional Commits](https://conventionalcommits.org/) for automated version management and release notes generation. |
| 4 | + |
| 5 | +## Format |
| 6 | + |
| 7 | +``` |
| 8 | +<type>[optional scope]: <description> |
| 9 | +
|
| 10 | +[optional body] |
| 11 | +
|
| 12 | +[optional footer(s)] |
| 13 | +``` |
| 14 | + |
| 15 | +## Types |
| 16 | + |
| 17 | +- **feat**: A new feature (triggers a minor version bump) |
| 18 | +- **fix**: A bug fix (triggers a patch version bump) |
| 19 | +- **docs**: Documentation only changes |
| 20 | +- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| 21 | +- **refactor**: A code change that neither fixes a bug nor adds a feature |
| 22 | +- **perf**: A code change that improves performance |
| 23 | +- **test**: Adding missing tests or correcting existing tests |
| 24 | +- **chore**: Changes to the build process or auxiliary tools and libraries |
| 25 | + |
| 26 | +## Breaking Changes |
| 27 | + |
| 28 | +Add `BREAKING CHANGE:` in the footer or append `!` after the type/scope to indicate breaking changes (triggers a major version bump). |
| 29 | + |
| 30 | +## Examples |
| 31 | + |
| 32 | +``` |
| 33 | +feat: add support for PHP 8.4 |
| 34 | +fix: resolve memory leak in CSV parsing |
| 35 | +docs: update installation instructions |
| 36 | +feat!: drop support for PHP 7.4 |
| 37 | +feat(csv): add new export format |
| 38 | +
|
| 39 | +BREAKING CHANGE: PHP 7.4 is no longer supported |
| 40 | +``` |
| 41 | + |
| 42 | +## Scopes (optional) |
| 43 | + |
| 44 | +You can use scopes to specify which part of the codebase is affected: |
| 45 | +- `csv`: CSV-related functionality |
| 46 | +- `holidays`: Holiday calculation features |
| 47 | +- `microplate`: Microplate handling |
| 48 | +- `phpstan`: PHPStan rules |
| 49 | +- `scanner`: Scanner-related features |
| 50 | +- `samplesheet`: Sample sheet functionality |
0 commit comments