|
| 1 | +# Release Notes Template for go-redis |
| 2 | + |
| 3 | +This template provides a structured format for creating release notes for go-redis releases. |
| 4 | + |
| 5 | +## Format Structure |
| 6 | + |
| 7 | +```markdown |
| 8 | +# X.Y.Z (YYYY-MM-DD) |
| 9 | + |
| 10 | +## 🚀 Highlights |
| 11 | + |
| 12 | +### [Category Name] |
| 13 | +Brief description of the major feature/change with context and impact. |
| 14 | +- Key points |
| 15 | +- Performance metrics if applicable |
| 16 | +- Links to documentation |
| 17 | + |
| 18 | +### [Another Category] |
| 19 | +... |
| 20 | + |
| 21 | +## ✨ New Features |
| 22 | + |
| 23 | +- Feature description ([#XXXX](https://github.com/redis/go-redis/pull/XXXX)) by [@username](https://github.com/username) |
| 24 | +- ... |
| 25 | + |
| 26 | +## 🐛 Bug Fixes |
| 27 | + |
| 28 | +- Fix description ([#XXXX](https://github.com/redis/go-redis/pull/XXXX)) by [@username](https://github.com/username) |
| 29 | +- ... |
| 30 | + |
| 31 | +## ⚡ Performance |
| 32 | + |
| 33 | +- Performance improvement description ([#XXXX](https://github.com/redis/go-redis/pull/XXXX)) by [@username](https://github.com/username) |
| 34 | +- ... |
| 35 | + |
| 36 | +## 🧪 Testing & Infrastructure |
| 37 | + |
| 38 | +- Testing/CI improvement ([#XXXX](https://github.com/redis/go-redis/pull/XXXX)) by [@username](https://github.com/username) |
| 39 | +- ... |
| 40 | + |
| 41 | +## 👥 Contributors |
| 42 | + |
| 43 | +We'd like to thank all the contributors who worked on this release! |
| 44 | + |
| 45 | +[@username1](https://github.com/username1), [@username2](https://github.com/username2), ... |
| 46 | + |
| 47 | +--- |
| 48 | + |
| 49 | +**Full Changelog**: https://github.com/redis/go-redis/compare/vX.Y-1.Z...vX.Y.Z |
| 50 | +``` |
| 51 | + |
| 52 | +## Guidelines |
| 53 | + |
| 54 | +### Highlights Section |
| 55 | +The Highlights section should contain the **most important** user-facing changes. Common categories include: |
| 56 | + |
| 57 | +- **Typed Errors** - Error handling improvements |
| 58 | +- **New Commands** - New Redis commands support (especially for new Redis versions) |
| 59 | +- **Search & Vector** - RediSearch and vector-related features |
| 60 | +- **Connection Pool** - Pool improvements and performance |
| 61 | +- **Metrics & Observability** - Monitoring and instrumentation |
| 62 | +- **Breaking Changes** - Any breaking changes (should be prominent) |
| 63 | + |
| 64 | +Each highlight should: |
| 65 | +- Have a descriptive title |
| 66 | +- Include context about why it matters |
| 67 | +- Link to relevant PRs |
| 68 | +- Include performance metrics if applicable |
| 69 | + |
| 70 | +### New Features Section |
| 71 | +- List all new features with PR links and contributor attribution |
| 72 | +- Use descriptive text, not just PR titles |
| 73 | +- Group related features together if it makes sense |
| 74 | + |
| 75 | +### Bug Fixes Section |
| 76 | +- Only include actual bug fixes |
| 77 | +- Be specific about what was broken and how it's fixed |
| 78 | +- Include issue links if the PR references an issue |
| 79 | + |
| 80 | +### Performance Section |
| 81 | +- Separate from New Features to highlight performance work |
| 82 | +- Include metrics when available (e.g., "47-67% faster", "33% less memory") |
| 83 | +- Explain the impact on users |
| 84 | + |
| 85 | +### Testing & Infrastructure Section |
| 86 | +- Include only important testing/CI changes |
| 87 | +- **Exclude** dependency bumps (e.g., dependabot PRs for actions) |
| 88 | +- **Exclude** minor CI tweaks unless they're significant |
| 89 | +- Include major Redis version updates in CI |
| 90 | + |
| 91 | +### What to Exclude |
| 92 | +- Dependency bumps (dependabot PRs) |
| 93 | +- Minor documentation typo fixes |
| 94 | +- Internal refactoring that doesn't affect users |
| 95 | +- Duplicate entries (same PR in multiple sections) |
| 96 | +- `dependabot[bot]` from contributors list |
| 97 | + |
| 98 | +### Formatting Rules |
| 99 | +1. **PR Links**: Use `([#XXXX](https://github.com/redis/go-redis/pull/XXXX))` format |
| 100 | +2. **Contributor Links**: Use `[@username](https://github.com/username)` format |
| 101 | +3. **Issue Links**: Use `([#XXXX](https://github.com/redis/go-redis/issues/XXXX))` format |
| 102 | +4. **Full Changelog**: Always include at the bottom with correct version comparison |
| 103 | + |
| 104 | +### Getting PR Information |
| 105 | +Use GitHub API to fetch PR details: |
| 106 | +```bash |
| 107 | +# Get recent merged PRs |
| 108 | +gh pr list --state merged --limit 50 --json number,title,author,mergedAt,url |
| 109 | +``` |
| 110 | + |
| 111 | +Or use the GitHub web interface to review merged PRs between releases. |
| 112 | + |
| 113 | +### Example Workflow |
| 114 | +1. Gather all merged PRs since last release |
| 115 | +2. Categorize PRs by type (feature, bug fix, performance, etc.) |
| 116 | +3. Identify the 3-5 most important changes for Highlights |
| 117 | +4. Remove duplicates and dependency bumps |
| 118 | +5. Add PR and contributor links |
| 119 | +6. Review for clarity and completeness |
| 120 | +7. Add Full Changelog link with correct version tags |
| 121 | + |
| 122 | +## Example (v9.17.0) |
| 123 | + |
| 124 | +See the v9.17.0 release notes in `RELEASE-NOTES.md` for a complete example following this template. |
| 125 | + |
0 commit comments