release-notes-template.md•2.31 kB
```markdown
# [Project/Product Name] [Version]
## 🚨 Breaking Changes (if any)
- **[Breaking Change 1]**: [Description of the breaking change]
- **[Breaking Change 2]**: [Description of another breaking change]
## Tools
### 🆕 New Tools
- **[Category 1]**: `[tool_name]`, `[another_tool_name]` - [Description of what these tools do]
- **[Category 2]**: `[tool_name]`, `[another_tool_name]` - [Description of what these tools do]
### 🔄 Changed Tools
- **[Category 1]**: [Description of changes]
- **`[tool_name]`** now includes functionality from:
- `[old_tool_name]` ([description])
- `[another_old_tool_name]` ([description])
- **[Category 2]**: [Description of changes]
- **`[old_tool_name]` + `[another_old_tool_name]`** → **`[new_tool_name]`**: [Description of the change]
### ❌ Removed Tools
- **`[removed_tool_name]`**: [Explanation of why it was removed and alternative if applicable]
- **`[another_removed_tool_name]`**: [Explanation of why it was removed and alternative if applicable]
## Functionality
### 🆕 New Features
- **[Feature Name]**: [Description of the new feature]
- [Configuration details if applicable]
- [Usage instructions if applicable]
- **[Another Feature Name]**: [Description of another new feature]
### 🔧 Improvements
- **[Improvement 1]**: [Description of the improvement]
- **[Improvement 2]**: [Description of another improvement]
- **[Improvement 3]**: [Description of yet another improvement]
### 🐛 Bug Fixes
- **[Bug Fix 1]**: [Description of what was fixed]
- **[Bug Fix 2]**: [Description of another bug that was fixed]
- **[Bug Fix 3]**: [Description of yet another bug fix]
## Contributors
Special thanks to all contributors who made this release possible:
- **[Contributor Name]** - [Description of contributions]
- **[Another Contributor]** - [Description of contributions]
---
## Migration Guide
### For users upgrading from [previous version]
1. **[Migration Step 1]**: [Detailed instructions]
2. **[Migration Step 2]**: [Detailed instructions with examples]
```[language]
# Old approach
[code example of old approach]
# New approach
[code example of new approach]
```
3. **[Migration Step 3]**: [More detailed instructions]
4. **[Migration Step 4]**: [Final migration steps]
```