Skip to content

Release Notes Template

Use this template for any project release notes

md
# [ProjectName] vX.Y.Z - YYYY-MM-DD

## 🚀 Additions

- Add [feature or option description](https://github.com/USERNAME/REPO/commit/COMMIT_HASH)
- Add support for XYZ format ([COMMIT_HASH](https://github.com/USERNAME/REPO/commit/COMMIT_HASH))
- Introduce new API endpoint for ABC ([COMMIT_HASH](https://github.com/USERNAME/REPO/commit/COMMIT_HASH))

## 🔄 Changes

- Change behavior of DEF to improve performance ([COMMIT_HASH](https://github.com/USERNAME/REPO/commit/COMMIT_HASH))
- Refactor internal logic for GHI ([COMMIT_HASH](https://github.com/USERNAME/REPO/commit/COMMIT_HASH))
- Update documentation and examples ([COMMIT_HASH](https://github.com/USERNAME/REPO/commit/COMMIT_HASH))

## 🐛 Fixes

- Fix bug where JKL caused crash on startup ([COMMIT_HASH](https://github.com/USERNAME/REPO/commit/COMMIT_HASH))
- Handle edge case for MNO input ([COMMIT_HASH](https://github.com/USERNAME/REPO/commit/COMMIT_HASH))
- Correct typo in error messages ([COMMIT_HASH](https://github.com/USERNAME/REPO/commit/COMMIT_HASH))

## ⚠️ Deprecations

- Deprecate old function `oldFunctionName()` ([COMMIT_HASH](https://github.com/USERNAME/REPO/commit/COMMIT_HASH))
- Mark legacy CLI option `--old-option` as deprecated ([COMMIT_HASH](https://github.com/USERNAME/REPO/commit/COMMIT_HASH))

## ❌ Removals

- Remove obsolete module XYZ ([COMMIT_HASH](https://github.com/USERNAME/REPO/commit/COMMIT_HASH))
- Delete legacy scripts no longer used ([COMMIT_HASH](https://github.com/USERNAME/REPO/commit/COMMIT_HASH))

## 📦 Contributors

Thanks to [username1](https://github.com/username1), [username2](https://github.com/username2), and all contributors for this release!