Skip to content

Commit 562f2f1

Browse files
committed
Add Release Pull Request template with semantic title guidelines
- Introduced a dedicated Pull Request template for release preparation under `.github/.github/PULL_REQUEST_TEMPLATE/Release.md`. - Defined detailed guidelines for PR title formatting, including allowed types (e.g., security, fix, perf) and scopes (e.g., application, domain, infrastructure). - Provided a checklist for key release tasks, such as updating CHANGELOG, running tests, and confirming CI/CD pipeline success. - Added sections for version details, related branches, and special release instructions to streamline the release process. - Supports adherence to semantic and standardized contribution practices.
1 parent 0b45618 commit 562f2f1

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# 🔖 Release PR
2+
3+
<!--
4+
PR TITLE FORMAT (REQUIRED):
5+
6+
<type>(<scope>): <short imperative summary>
7+
8+
Allowed types:
9+
- security
10+
- fix
11+
- perf
12+
- feat
13+
- refactor
14+
- docs
15+
- chore
16+
- ci
17+
- composer
18+
19+
Allowed scopes:
20+
application | domain | infrastructure | kernel | shared | support | tests | deps | other
21+
22+
PR semantic MUST represent the DOMINANT change.
23+
Priority order:
24+
security > fix > perf > feat > refactor > docs > chore > ci > composer
25+
-->
26+
27+
### Version
28+
29+
- Release version: `vX.Y.Z`
30+
31+
### Related Branches
32+
33+
- Release branch: `release/vX.Y.Z`
34+
- Target branch: `develop` / `master` (delete as appropriate)
35+
36+
### Description
37+
38+
This PR prepares the release branch for version `vX.Y.Z`. It should include:
39+
40+
- Changelog updates
41+
- README / documentation updates
42+
- Any configuration changes required for release
43+
- Final fixes / tweaks
44+
45+
### Checklist
46+
47+
- [ ] Update `CHANGELOG.md` for this release
48+
- [ ] Update `README.md` if needed
49+
- [ ] Run tests for all core and adapter modules
50+
- [ ] Verify CI/CD pipelines pass
51+
- [ ] Tag release commit with version `vX.Y.Z`
52+
- [ ] Merge release branch into `develop` \ `master`
53+
54+
### Notes / Special Instructions
55+
56+
- Include any special notes about the release, deployment instructions, or known issues.

0 commit comments

Comments
 (0)