# SOFTWARE RELEASE NOTES

<!--
  Release Notes Template — Word / .docx friendly version
  ---------------------------------------------------------------
  Companion to https://www.dokly.co/blog/release-notes-template

  How to use in Microsoft Word:
    1. File > Open… → select this .md file (Word 2019+ opens Markdown).
       OR paste the whole thing into a blank .docx.
    2. Apply Heading 1 to "SOFTWARE RELEASE NOTES" and to each numbered
       section header. Apply Heading 2 to sub-sections.
    3. Save As → Word Document (.docx).

  All bracketed text like [Product name] is meant to be replaced.
  Sections you do not need can be deleted — they map 1:1 to the Markdown
  version shipped with your codebase.
-->

**Product:**        `[Product name]`
**Version:**        `[e.g. 2.4.0]`
**Release date:**   `[YYYY-MM-DD]`
**Release type:**   `[Major | Minor | Patch | Hotfix | Security]`
**Prepared by:**    `[Name, role]`
**Approved by:**    `[Name, role, date]`

---

## 1. Release summary

One paragraph. What shipped, who it affects, why it matters. Keep it to
three or four sentences — anyone who needs deeper context reads the
sections below.

## 2. New features

- **[Feature name]** — one-line description — [link to spec / ticket]
- **[Feature name]** — one-line description — [link to spec / ticket]

## 3. Enhancements

- **[What changed]** — why users will notice
- **[What changed]** — why users will notice

## 4. Fixed issues

| Ticket | Title | Affected versions |
| ------ | ----- | ----------------- |
| TICK-123 | Race condition in webhook signing for payloads over 1 MB | 2.3.0 – 2.3.4 |
| TICK-456 | Timezone offset bug in events.list() when filtering by date | 2.3.2 – 2.3.4 |

## 5. Known issues

- **[Title]** — workaround — target fix version
- **[Title]** — workaround — target fix version

## 6. Breaking changes / deprecations

> **Read this section first if you consume the API or SDK.**

- **[What changed]** — migration path — removal date
- **[What changed]** — migration path — removal date

## 7. Security updates

- **[CVE or advisory ID]** — severity — action required
- **[CVE or advisory ID]** — severity — action required

## 8. Upgrade instructions

```
# Example — replace with the real command for your product
npm install your-package@2.4.0
```

Step-by-step instructions if the upgrade is non-trivial. Note any
downtime, database migrations, or configuration changes.

## 9. Rollback plan

How to revert if something breaks in production. Owner: `[on-call role]`.
Feature-flag toggle, previous artifact URL, and expected impact window.

## 10. Attachments

- Test report — `[link]`
- Security scan — `[link]`
- Sign-off log — `[link]`
- Full changelog — `[link to CHANGELOG.md or GitHub compare URL]`

---

*Template maintained at https://www.dokly.co/blog/release-notes-template — copy freely.*