Skip to content

Release Note Formats

Rémy Denton edited this page Jul 16, 2020 · 4 revisions

As of 7/2020, release notes are automatically generated.


General Guidelines

Each release note should be broken down by a few main topics, and use animated GIFs wherever you see fit.

Item Format

Each line should consist of the PR link and a one-liner summary.

Example

  • #123 - Added Rendering API which powers the new component viewer added to the docs site
  • #124 - Added new Button component

Main Topics

  1. What's New?
  2. Enhancements
  3. Fixes
  4. Deprecated

Categories

Use categories within each topic to group related items.

@todo: create Github placeholder template.

Clone this wiki locally