|
1 | 1 | ## PR Title Format |
2 | 2 |
|
3 | | -**Please ensure your PR title follows one of these formats:** |
| 3 | +**Please ensure your PR title follows [Conventional Commits](https://www.conventionalcommits.org/) format:** |
4 | 4 |
|
5 | | -### Version Bumping Prefixes (trigger Docker build + version bump): |
6 | | -- `feat: <description>` - New features (triggers MINOR version bump) |
7 | | -- `fix: <description>` - Bug fixes (triggers PATCH version bump) |
8 | | -- `breaking: <description>` or `BREAKING CHANGE: <description>` - Breaking changes (triggers MAJOR version bump) |
9 | | -- `perf: <description>` - Performance improvements (triggers PATCH version bump) |
10 | | -- `refactor: <description>` - Code refactoring (triggers PATCH version bump) |
| 5 | +### Version Bumping Types (trigger semantic release): |
| 6 | +- `feat: <description>` - New features → **MINOR** version bump (1.1.0 → 1.2.0) |
| 7 | +- `fix: <description>` - Bug fixes → **PATCH** version bump (1.1.0 → 1.1.1) |
| 8 | +- `perf: <description>` - Performance improvements → **PATCH** version bump (1.1.0 → 1.1.1) |
11 | 9 |
|
12 | | -### Non-Version Prefixes (no version bump): |
13 | | -- `docs: <description>` - Documentation only |
| 10 | +### Breaking Changes (trigger MAJOR version bump): |
| 11 | +For breaking changes, use any commit type above with `BREAKING CHANGE:` in the commit body or `!` after the type: |
| 12 | +- `feat!: <description>` → **MAJOR** version bump (1.1.0 → 2.0.0) |
| 13 | +- `fix!: <description>` → **MAJOR** version bump (1.1.0 → 2.0.0) |
| 14 | + |
| 15 | +### Non-Versioning Types (no release): |
| 16 | +- `build: <description>` - Build system changes |
14 | 17 | - `chore: <description>` - Maintenance tasks |
15 | | -- `test: <description>` - Test additions/changes |
16 | 18 | - `ci: <description>` - CI/CD changes |
17 | | -- `style: <description>` - Code style changes |
18 | | - |
19 | | -### Docker Build Options: |
20 | | -- `docker: <description>` - Force Docker build without version bump |
21 | | -- `docs+docker: <description>` - Documentation + Docker build |
22 | | -- `chore+docker: <description>` - Maintenance + Docker build |
23 | | -- `test+docker: <description>` - Tests + Docker build |
24 | | -- `ci+docker: <description>` - CI changes + Docker build |
25 | | -- `style+docker: <description>` - Style changes + Docker build |
| 19 | +- `docs: <description>` - Documentation only |
| 20 | +- `refactor: <description>` - Code refactoring (no functional changes) |
| 21 | +- `style: <description>` - Code style/formatting changes |
| 22 | +- `test: <description>` - Test additions/changes |
| 23 | + |
| 24 | +### Docker Build Triggering: |
| 25 | + |
| 26 | +Docker builds are **independent** of versioning and trigger based on: |
| 27 | + |
| 28 | +**Automatic**: When PRs modify relevant files: |
| 29 | +- Python files (`*.py`), `requirements*.txt`, `pyproject.toml` |
| 30 | +- Docker files (`Dockerfile`, `docker-compose.yml`, `.dockerignore`) |
| 31 | + |
| 32 | +**Manual**: Add the `docker-build` label to force builds for any PR. |
26 | 33 |
|
27 | 34 | ## Description |
28 | 35 |
|
|
0 commit comments