-
Notifications
You must be signed in to change notification settings - Fork 608
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
KIKIMR-22202 Changes in PR template and docs for contributors with requirements to PR description #14031
KIKIMR-22202 Changes in PR template and docs for contributors with requirements to PR description #14031
Conversation
…quirements to PR description
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
⚪ Test history | Ya make output | Test bloat
🟢 |
Co-authored-by: Ivan Blinkov <[email protected]>
✅ Documentation buildRevision built successfully |
⚪ Test history | Ya make output | Test bloat
🟢 |
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
✅ Documentation buildRevision built successfully |
⚪ Test history | Ya make output | Test bloat
🟢 |
❌ Documentation buildRevision build failed Build logsErrors (1)❌ /ru/contributor/suggest-change.md: 300: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] |
✅ Documentation buildRevision built successfully |
⚪ Test history | Ya make output | Test bloat
🟢 |
⚪ Test history | Ya make output | Test bloat
🟢 |
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
|
||
1. **Changelog Entry.** В этот блок следует добавить описание изменения для конечных пользователей системы (см. [требования](#changelog_entry_req)). Содержимое этого блока будет опубликовано в [списке изменений](../changelog-server.md), если PR будет замержен. | ||
2. **Changelog Category.** В этом блоке нужно оставить одну категорию из списка, которой соответствует изменение (см. [как выбрать категорию](#choose_category)). Есть категории, для которых сообщения из Changelog Entry не будут опубликованы в списке изменений. Остальные категории определяют раздел списка изменений, в который попадёт сообщение. | ||
3. **Description.** В этот блок можно добавить ссылку на задачу и любую дополнительную информацию, которую вы считаете полезной для ревью. Содержимое этого блока не попадёт в список изменений. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Я бы сказал, что это описание для ревьювера, то есть для коллеги-разработчика. Предлагаю более явно выразить эту мысль. Например "Description for reviewer"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Поправила.
|
||
При создании Pull Request'а описание будет заполнено текстом из шаблона, который нужно отредактировать: | ||
|
||
1. **Changelog Entry.** В этот блок следует добавить описание изменения для конечных пользователей системы (см. [требования](#changelog_entry_req)). Содержимое этого блока будет опубликовано в [списке изменений](../changelog-server.md), если PR будет замержен. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Я бы поменял местами Changelog Category и Changelog Entry. Сначала выбираешь категорию, потом уже пишешь текст. Если "Not for Changelog" то я бы написал, что Changelog Entry можно пропустить, так?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Поправила
Co-authored-by: Andrey Fomichev <[email protected]>
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
⚪ Test history | Ya make output | Test bloat
🟢 |
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
⚪ Test history | Ya make output | Test bloat
🟢 |
Changelog entry
Added docs for contibutors with requirements to PR description.
Changed PR Template:
Changelog category
Additional information