Skip to content

Latest commit

 

History

History
47 lines (37 loc) · 1.4 KB

release-note-guideline.md

File metadata and controls

47 lines (37 loc) · 1.4 KB

Release Note Guide

references ESLint, Vuejs

Title

  • should be a tag name.

  • follows semantic versioning.

  • If this published to npm, tag name should start with v to avoid conflict with semver. For more information see this.

Description Format

## Highlights
* Short Description on change
  more descriptions if necessary
* Short Description on change
* Short Description on change
- - -

<Changes>

Highlights Description

  • summary of this release, user should know.
  • can be anything in <Changes>. It could be a bug fix, updating feature, add new feature, etc.
  • order Short Description by importance

Changes

## <type-of-changes1>
* <short-hash> <pull-request-title> (<PR-id>)

## <type-of-changes2>
* <short-hash> <pull-request-title> (<PR-id>) 
* <short-hash> <pull-request-title> (<PR-id>) (@<contributer>)
  • <short-hash> is a last merge commit, before PR received.
  • add <contributer> only if contributer is not manitainer/owner.

Type of Changes

  • Features - Commit start with New, feat
  • Enhancements - Commit start with Update, refactor, perf
  • Bug Fixes - Commit start with fix
  • Documentation - Commit start with docs
  • Chores - Commit start with style, test, chore