1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
# 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](generate-changelog.md).
2. Every note starts with the "do" form of a verb. For example:
- Support backup to S3 with [Backup & Restore (BR)](https://github.com/pingcap/br)
- Fix Docker ulimit configuring for the latest EKS AMI
3. Ensure no period at the end of note.
4. 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
5. 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)
6. 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)
|
