Skip to main content

Release Notes Template

Use this template when drafting a GitHub release for fased X.Y.Z.

Highlights

  • High-signal user-facing changes only
  • 3 to 7 bullets max

What Changed

  • Gateway / CLI:
  • UI / web:
  • Apps / nodes:
  • Extensions / plugins:
  • Docs:

Operator Impact

  • Onboarding / install changes:
  • Hosting-mode changes:
  • Wallet / signer changes:
  • Federation changes:
  • Mining changes:

Breaking Or Risky Changes

  • Breaking config changes:
  • Behavior changes to watch:
  • Rollback or disable path:

Upgrade Notes

  • Commands to run:
  • Migrations or follow-up steps:
  • Anything users should verify after upgrade:

Verification

  • Build and checks run:
  • Manual verification performed:
  • Known gaps: