- Feature Name: Description of the new feature and how to use it.
- Example:
feature details, command to activate
- Example:
- Improvement Name: Description of the improvement and its impact.
- Example:
improvement details, before and after comparison
- Example:
- Bug Fix Name: Description of the bug and the fix applied.
- Example:
bug details, steps to reproduce, fixed behavior
- Example:
- Refactor Name: Description of the code refactoring and the reason behind it.
- Example:
refactor details, what was changed, why it was changed
- Example:
- Maintenance Task: Description of any maintenance tasks performed.
- Example:
details of the task, impact on the project
- Example:
- Documentation Update: Description of changes or additions to documentation.
- Example:
details of the update, new sections added
- Example:
- Deprecated Feature: Description of any deprecated features and alternatives if available.
- Example:
deprecated feature details, suggested alternatives
- Example:
- Migration Instruction: Description of any breaking changes and how to migrate from the previous version.
- Example:
steps for migration, important considerations
- Example:
- Commit ID: Description of the commit
- Example:
commit message, associated issue number
- Example:
- Issue Name: Description of known issues in this release.
- Example:
issue details, impact, workaround
- Example:
Generated by Project Name on YYYY-MM-DD.