Skip to content

Commit 9f5c77f

Browse files
committed
fix: align PR template with actual semantic-release and Docker workflows
The PR template was outdated and misaligned with the actual workflow behavior introduced in PR #217. Key fixes: - **Semantic Release**: Now matches pyproject.toml configuration - feat → MINOR, fix/perf → PATCH (not refactor) - Added missing 'build' type from allowed_tags - Fixed breaking change syntax (feat\!, BREAKING CHANGE: in body) - Removed incorrect 'breaking:' prefix format - **Docker Builds**: Clarified independence from versioning - Builds trigger on file changes (Python, Docker files) - Manual triggering via 'docker-build' label - Removed misleading 'trigger Docker build + version bump' claims - **Conventional Commits**: Added link to official specification The template now accurately reflects the semantic-release config and docker-pr.yml workflow implementation, preventing contributor confusion.
1 parent 3c80850 commit 9f5c77f

File tree

1 file changed

+26
-19
lines changed

1 file changed

+26
-19
lines changed

.github/pull_request_template.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,35 @@
11
## PR Title Format
22

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:**
44

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)
119

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
1417
- `chore: <description>` - Maintenance tasks
15-
- `test: <description>` - Test additions/changes
1618
- `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.
2633

2734
## Description
2835

0 commit comments

Comments
 (0)