Skip to content

release-note-guide.md

Latest commit

 

History

History
40 lines (27 loc) · 1.58 KB

release-note-guide.md

File metadata and controls

40 lines (27 loc) · 1.58 KB

Release Notes Language Style Guide

When you write a release note for your pull request, make sure that your language style meets the following rules:

  1. Include ACTION REQUIRED: at the beginning if the change requires user action, e.g. deprecating or abandoning features:

    • ACTION REQUIRED: Add the timezone support for [all charts]

Then, add label release-note-action-required onto the PR. This is required by the tool we use to generate change log.

  1. Every note starts with the "do" form of a verb. For example:

  2. Ensure no period at the end of note.

  3. Use a single backquote (``) to frame the following elements in your release notes:

    • Custom Resource name, e.g. TidbCluster, Backup
    • Kubernetes Resource name, e.g. Pod, StatefulSet
    • Configuration item name, e.g. .spec.version
    • Variable name
    • Variable value
    • Error message
    • Field name

  4. Pay attention to the capitalization of the following terms that are often misspelled:

    • PD, TiKV, TiDB (not pd, tikv, tidb)
    • TiDB Operator (not tidb operator)
    • TiDB Binlog (not tidb binlog)

  5. The following templates are commonly used in release notes:

    • Fix the issue that ... when doing (an operation)/ when (... occurs)
    • Fix the issue that ... because ... (the cause of the problem)
    • Add the feature of (something/doing something) to do (the purpose)
    • Support (something/doing something)