Skip to content

Commit fbb2463

Browse files
docs(github): enhance PR template for automated release notes
- Add emoji-based type categorization (feat, fix, docs, chore, etc.) - Include 'Release Notes Impact' section to distinguish user-facing changes - Add dedicated section for breaking changes and migration guidance - Improve conventional commit format guidance - Support better automated categorization in release notes generation
1 parent ac7b9f7 commit fbb2463

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

.github/pull_request_template.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,21 @@
22
Explain the change in 1–3 sentences. Reference any related issues (e.g. Closes #123).
33

44
## Type of Change
5-
- [ ] Feature
6-
- [ ] Bug fix
7-
- [ ] Chore / Refactor
8-
- [ ] Docs
9-
- [ ] Tests
10-
- [ ] CI / Build
11-
- [ ] Other
5+
<!-- Select the primary type of change. This helps with automated release note generation. -->
6+
- [ ] 🚀 **Feature** (`feat:`) - New functionality for users
7+
- [ ] 🐛 **Bug fix** (`fix:`) - Fixes an issue for users
8+
- [ ] ⚠️ **Breaking Change** (`feat!:` or `fix!:`) - Changes that break backward compatibility
9+
- [ ] 📚 **Docs** (`docs:`) - Documentation updates only
10+
- [ ] 🔧 **Chore / Refactor** (`chore:`, `refactor:`) - Internal changes, no user impact
11+
- [ ] 🧪 **Tests** (`test:`) - Test additions or updates
12+
- [ ] 🚀 **CI / Build** (`ci:`) - Build system or CI changes
13+
- [ ] 📦 **Dependencies** (`deps:`) - Dependency updates
14+
- [ ] 🎉 **Other** - Changes that don't fit the above categories
15+
16+
## Release Notes Impact
17+
<!-- This helps generate better automated release notes -->
18+
- [ ] **User-facing change** - Should be included in release notes
19+
- [ ] **Internal change only** - No need to include in release notes
1220

1321
## Motivation / Context
1422
Why is this change needed? What problem does it solve or what capability does it add?
@@ -42,12 +50,21 @@ node bin/index.js demo --services node --no-install --yes
4250
```
4351
Result: ✅ / ❌
4452

53+
## Breaking Changes & Migration
54+
<!-- If this is a breaking change, provide details for users -->
55+
**Breaking changes:**
56+
57+
**Migration steps:**
58+
59+
**Configuration changes needed:**
60+
4561
## Screenshots / Logs (Optional)
4662
Add any helpful output (chalk-styled CLI messages, error reproduction, etc.).
4763

4864
## Docs
4965
- [ ] Updated `README.md` if needed
5066
- [ ] Updated `.github/copilot-instructions.md` if internal conventions changed
67+
- [ ] Added/updated relevant documentation for user-facing changes
5168
- [ ] Not applicable
5269

5370
## Checklist

0 commit comments

Comments
 (0)