Примечания к выпуску. Правила стиля языка

Когда вы пишете примечание к выпуску для своего pull request, убедитесь, что стиль вашего языка соответствует следующим правилам:

1. Включите ACTION REQUIRED: в начале, если изменение требует действий пользователя, например, отмена или отказ от функций:

   • ACTION REQUIRED: Добавьте поддержку временных зон для [всех диаграмм]

Затем добавьте метку release-note-action-required к PR. Это необходимо для инструмента, который мы используем для генерации журнала изменений.

2. Каждое примечание начинается с "действительной" формы глагола. Например:

   • Поддержка резервного копирования на S3 с Backup & Restore (BR)
   • Исправление конфигурации ulimit Docker для последней версии EKS AMI

3. Убедитесь, что в конце примечания нет точки.

4. Используйте одинарную обратную кавычку (`) для выделения следующих элементов в ваших примечаниях к выпуску:

   • Имя пользовательского ресурса, например, TidbCluster, Backup
   • Имя ресурса Kubernetes, например, Pod, StatefulSet
   • Имя элемента конфигурации, например, .spec.version
   • Имя переменной
   • Значение переменной
   • Сообщение об ошибке
   • Имя поля

5. Обратите внимание на правильное написание следующих терминов, которые часто ошибочно пишутся:

   • PD, TiKV, TiDB (не pd, tikv, tidb)

   • TiDB Operator (не tidb operator)

   • TiDB Binlog (не tidb binlog)6. Следующие шаблоны часто используются в примечаниях к выпуску:

   • Исправление проблемы, что ... при выполнении (операции)/ при (... событии)

   • Исправление проблемы, что ... потому что ... (причина проблемы)

   • Добавление функции (что-то/выполнение чего-то) для (цели)

   • Поддержка (что-то/выполнение чего-то)