Skip to content

RELEASE_NOTE_TEMPLATE.md

Latest commit

 

History

History
127 lines (77 loc) · 3.11 KB

RELEASE_NOTE_TEMPLATE.md

File metadata and controls

127 lines (77 loc) · 3.11 KB

(Example: Midnight.js 3.1.0)

  • Date: YYYY-MM-DD
  • Environment: All public networks at time of release. For the full compatibility matrix, see the release notes overview.

High-level summary

1–3 sentences summarizing the most important changes in this release Example: "This release updates the Compact compiler to 0.27, introduces ledger v6 on Preview, and adds new ZK proof APIs. Breaking changes affect all Preview developers."

Audience

These release notes are intended for:

  • Operators who run a node on Preview.
  • Developers who use Compact compiler or SDK version X.
  • Administrators who maintain infrastructure for Testnet environments.

What changed

high-level list of new features, improvements, fixes

Examples:

  • Updated Compact compiler to .
  • Added ledger feature .
  • Improved SDK method .
  • Fixed affecting .

New features

List all newly introduced functionality.

Feature name

Description: what it does + why it matters + where developers interact with it + motivation behind updates, all written in plain developer-focused language

New features requiring configuration updates

(Not necessarily breaking, but requires setup changes.)

Feature name

Required updates:

Impact: <why this configuration is needed + when it must be applied>

Improvements

Non-breaking enhancements.

Improvement:

Description: <explain the enhancement, UX lift, performance gain, and so on.>

Example:

  • "Enhanced proof generation performance for large circuits."
  • "Redesigned CLI prompts for clarity."

Deprecations

List APIs, functions, flags, or semantics being phased out.

For each item, include:

  • What is deprecated
  • When the deprecation begins
  • When it will be removed
  • What developers should use instead
  • Migration notes

Deprecated item: <API/function/feature>

Starts: <date/version>
Full removal: <planned removal date/version>
Replacement: <new API/method>
Migration steps:

Breaking changes

Below is a list of breaking changes and required actions for developers.

Breaking change

What changed:

What breaks:

Required actions:

  • <step 1>
  • <step 2>
  • <environment/version pinning>

Code example:

Known issues

The following issues are known at the time of release:

Issue name

Description: <what's affected + conditions> Workaround (if any):

Links and references

  • PRs:
  • Engineering docs:
  • Migration guides:
  • SDK docs:
  • Known issues board:

Fixed defect list

The following defects were fixed in .

Defect number Description
PR-XX The app crashes when you type 'explode.'