mirror of
https://github.com/conventional-commits/conventionalcommits.org.git
synced 2025-09-18 21:07:48 +02:00
docs(ru): format documentation for consistency
This commit is contained in:
parent
9b8b992729
commit
ec7a65ff2f
@ -25,6 +25,7 @@ aliases: ["/ru/"]
|
||||
|
||||
[необязательная(ые) сноска(и)]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
<br />
|
||||
@ -57,6 +58,7 @@ _Контекст_ может быть добавлен к _типу_ комми
|
||||
## Примеры
|
||||
|
||||
### Сообщение коммита с _описанием_ и _сноской_ `BREAKING CHANGE`
|
||||
|
||||
```
|
||||
feat: allow provided config object to extend other configs
|
||||
|
||||
@ -64,16 +66,19 @@ BREAKING CHANGE: `extends` key in config file is now used for extending other co
|
||||
```
|
||||
|
||||
### Сообщение коммита с `!` для привлечения внимания к `BREAKING CHANGE`
|
||||
|
||||
```
|
||||
feat!: send an email to the customer when a product is shipped
|
||||
```
|
||||
|
||||
### Сообщение коммита с _контекстом_ и `!` для привлечения внимания к `BREAKING CHANGE`
|
||||
|
||||
```
|
||||
feat(api)!: send an email to the customer when a product is shipped
|
||||
```
|
||||
|
||||
### Сообщение коммита вместе с `!` и _сноской_ `BREAKING CHANGE`
|
||||
|
||||
```
|
||||
chore!: drop support for Node 6
|
||||
|
||||
@ -81,16 +86,19 @@ BREAKING CHANGE: use JavaScript features not available in Node 6.
|
||||
```
|
||||
|
||||
### Сообщение коммита без _тела_
|
||||
|
||||
```
|
||||
docs: correct spelling of CHANGELOG
|
||||
```
|
||||
|
||||
### Сообщение коммита с _контекстом_
|
||||
|
||||
```
|
||||
feat(lang): add polish language
|
||||
```
|
||||
|
||||
### Сообщение коммита с _телом_ из нескольких абзацев и несколькими _сносками_
|
||||
|
||||
```
|
||||
fix: prevent racing of requests
|
||||
|
||||
@ -123,7 +131,7 @@ Refs: #123
|
||||
1. _Описание_ должно (MUST) следовать сразу за двоеточием (`:`) и пробелом
|
||||
(` `) после _типа_ или _контекста_. _Описание_ представляет собой краткое
|
||||
изложение изменений кода. Например, `fix: array parsing issue when multiple
|
||||
spaces were contained in string`.
|
||||
spaces were contained in string`.
|
||||
1. _Тело_ коммита может (MAY) следовать после короткого _описания_, добавляя
|
||||
дополнительную контекстную информацию об изменениях в коде. _Тело_ должно
|
||||
(MUST) отделяться от _описания_ одной пустой строкой.
|
||||
@ -145,7 +153,7 @@ Refs: #123
|
||||
1. Если `BREAKING CHANGE` включено в _сноску_, то оно должно (MUST) состоять из
|
||||
прописного текста `BREAKING CHANGE`, за которым следует двоеточие (`:`),
|
||||
пробел (` `) и _описание_. Например, `BREAKING CHANGE: environment
|
||||
variables now take precedence over config files`.
|
||||
variables now take precedence over config files`.
|
||||
1. Если критические изменения находятся в _типе_ или _контексте_, то они должны
|
||||
(MUST) быть обозначены восклицательным знаком (`!`), непосредственно перед
|
||||
двоеточием (`:`). Если используется восклицательный знак (`!`), то
|
||||
@ -161,13 +169,13 @@ Refs: #123
|
||||
|
||||
## Зачем использовать «Соглашение о коммитах»
|
||||
|
||||
* Автоматическое создание списков изменения.
|
||||
* Автоматическое определение семантического повышения версии (на основе _типов_
|
||||
- Автоматическое создание списков изменения.
|
||||
- Автоматическое определение семантического повышения версии (на основе _типов_
|
||||
совершённых коммитов).
|
||||
* Информирование товарищей по команде, общественности и других заинтересованных
|
||||
- Информирование товарищей по команде, общественности и других заинтересованных
|
||||
сторон о характере изменений.
|
||||
* Запуск процессов сборки и публикации.
|
||||
* Упрощать людям участие в ваших проектах, позволив им изучить более
|
||||
- Запуск процессов сборки и публикации.
|
||||
- Упрощать людям участие в ваших проектах, позволив им изучить более
|
||||
структурированную историю коммитов.
|
||||
|
||||
## FAQ (часто задаваемые вопросы)
|
||||
@ -175,7 +183,7 @@ Refs: #123
|
||||
### Как мне поступать с сообщениями коммитов на начальном этапе разработки?
|
||||
|
||||
Мы рекомендуем действовать так, как если бы вы уже выпустили продукт. Обычно
|
||||
*кто-то*, даже если это ваши коллеги-разработчики программного обеспечения,
|
||||
_кто-то_, даже если это ваши коллеги-разработчики программного обеспечения,
|
||||
использует ваше программное обеспечение. Они захотят знать, что исправлено,
|
||||
что ломается и т. д.
|
||||
|
||||
@ -241,6 +249,7 @@ Refs: #123
|
||||
### Как «Соглашение о коммитах» обрабатывает отмену коммитов?
|
||||
|
||||
Отмена изменений кода может быть сложной:
|
||||
|
||||
- Вы отменяете изменения нескольких коммитов?
|
||||
- Если вы отмените изменения новых функций, должен ли следующий выпуск быть
|
||||
патчем?
|
||||
|
Loading…
Reference in New Issue
Block a user