Skip to content
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

Merged
merged 10 commits into from
Feb 14, 2025

Conversation

galnat
Copy link
Collaborator

@galnat galnat commented Jan 30, 2025

Changelog entry

Added docs for contibutors with requirements to PR description.

Changed PR Template:

  • rename Additional Info to Description
  • add User Interface category

Changelog category

  • Documentation (changelog entry is not required)

Additional information

@galnat galnat requested a review from a team as a code owner January 30, 2025 14:38
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 30, 2025
Copy link

github-actions bot commented Jan 30, 2025

2025-01-30 14:43:32 UTC Pre-commit check linux-x86_64-release-asan for 4324f33 has started.
2025-01-30 14:49:33 UTC Artifacts will be uploaded here
2025-01-30 14:51:57 UTC ya make is running...
🟢 2025-01-30 14:52:02 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-01-30 14:52:08 UTC Build successful.

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Copy link

github-actions bot commented Jan 30, 2025

2025-01-30 15:08:44 UTC Pre-commit check linux-x86_64-relwithdebinfo for 4324f33 has started.
2025-01-30 15:08:58 UTC Artifacts will be uploaded here
2025-01-30 15:11:30 UTC ya make is running...
🟢 2025-01-30 15:11:35 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-01-30 15:11:47 UTC Build successful.

.github/PULL_REQUEST_TEMPLATE.md Show resolved Hide resolved
ydb/docs/ru/core/contributor/suggest-change.md Outdated Show resolved Hide resolved
ydb/docs/ru/core/contributor/suggest-change.md Outdated Show resolved Hide resolved
ydb/docs/ru/core/contributor/suggest-change.md Outdated Show resolved Hide resolved
ydb/docs/ru/core/contributor/suggest-change.md Outdated Show resolved Hide resolved
ydb/docs/ru/core/contributor/suggest-change.md Outdated Show resolved Hide resolved
ydb/docs/ru/core/contributor/suggest-change.md Outdated Show resolved Hide resolved
ydb/docs/ru/core/contributor/suggest-change.md Outdated Show resolved Hide resolved
ydb/docs/ru/core/contributor/suggest-change.md Outdated Show resolved Hide resolved
Copy link

github-actions bot commented Feb 2, 2025

✅ Documentation build

Revision built successfully
Revision preview link

Copy link

github-actions bot commented Feb 2, 2025

2025-02-02 09:31:00 UTC Pre-commit check linux-x86_64-relwithdebinfo for 796117a has started.
2025-02-02 09:31:13 UTC Artifacts will be uploaded here
2025-02-02 09:33:38 UTC ya make is running...
🟢 2025-02-02 09:35:08 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-02-02 09:35:14 UTC Build successful.

Copy link

github-actions bot commented Feb 2, 2025

2025-02-02 09:31:09 UTC Pre-commit check linux-x86_64-release-asan for 796117a has started.
2025-02-02 09:31:22 UTC Artifacts will be uploaded here
2025-02-02 09:33:52 UTC ya make is running...
🟢 2025-02-02 09:35:31 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-02-02 09:35:37 UTC Build successful.

@galnat galnat requested a review from antonkovalenko February 2, 2025 09:32
Copy link

github-actions bot commented Feb 4, 2025

✅ Documentation build

Revision built successfully
Revision preview link

Copy link

github-actions bot commented Feb 4, 2025

✅ Documentation build

Revision built successfully
Revision preview link

Copy link

github-actions bot commented Feb 4, 2025

2025-02-04 15:32:57 UTC Pre-commit check linux-x86_64-release-asan for a0686d9 has started.
2025-02-04 15:33:16 UTC Artifacts will be uploaded here
2025-02-04 15:35:47 UTC ya make is running...
🟢 2025-02-04 15:37:28 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-02-04 15:37:37 UTC Build successful.

Copy link

github-actions bot commented Feb 4, 2025

❌ Documentation build

Revision build failed

Build logs

Errors (1)

❌ /ru/contributor/suggest-change.md: 300: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

Copy link

github-actions bot commented Feb 4, 2025

✅ Documentation build

Revision built successfully
Revision preview link

Copy link

github-actions bot commented Feb 4, 2025

2025-02-04 17:10:41 UTC Pre-commit check linux-x86_64-release-asan for 2816237 has started.
2025-02-04 17:11:38 UTC Artifacts will be uploaded here
2025-02-04 17:14:52 UTC ya make is running...
🟢 2025-02-04 17:14:58 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-02-04 17:15:06 UTC Build successful.

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Feb 4, 2025
@galnat galnat requested review from nikitka and removed request for nikitka February 4, 2025 17:52
@blinkov blinkov enabled auto-merge (squash) February 7, 2025 06:53
Copy link

github-actions bot commented Feb 7, 2025

2025-02-07 06:59:30 UTC Pre-commit check linux-x86_64-release-asan for be83c0a has started.
2025-02-07 06:59:42 UTC Artifacts will be uploaded here
2025-02-07 07:02:10 UTC ya make is running...
🟢 2025-02-07 07:03:38 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-02-07 07:03:44 UTC Build successful.

Copy link

github-actions bot commented Feb 7, 2025

2025-02-07 06:59:30 UTC Pre-commit check linux-x86_64-relwithdebinfo for be83c0a has started.
2025-02-07 06:59:41 UTC Artifacts will be uploaded here
2025-02-07 07:02:09 UTC ya make is running...
🟢 2025-02-07 07:03:34 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-02-07 07:03:39 UTC Build successful.

Copy link

github-actions bot commented Feb 7, 2025

✅ Documentation build

Revision built successfully
Revision preview link

antonkovalenko
antonkovalenko previously approved these changes Feb 7, 2025

1. **Changelog Entry.** В этот блок следует добавить описание изменения для конечных пользователей системы (см. [требования](#changelog_entry_req)). Содержимое этого блока будет опубликовано в [списке изменений](../changelog-server.md), если PR будет замержен.
2. **Changelog Category.** В этом блоке нужно оставить одну категорию из списка, которой соответствует изменение (см. [как выбрать категорию](#choose_category)). Есть категории, для которых сообщения из Changelog Entry не будут опубликованы в списке изменений. Остальные категории определяют раздел списка изменений, в который попадёт сообщение.
3. **Description.** В этот блок можно добавить ссылку на задачу и любую дополнительную информацию, которую вы считаете полезной для ревью. Содержимое этого блока не попадёт в список изменений.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Я бы сказал, что это описание для ревьювера, то есть для коллеги-разработчика. Предлагаю более явно выразить эту мысль. Например "Description for reviewer"

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Поправила.

ydb/docs/ru/core/contributor/suggest-change.md Outdated Show resolved Hide resolved

При создании Pull Request'а описание будет заполнено текстом из шаблона, который нужно отредактировать:

1. **Changelog Entry.** В этот блок следует добавить описание изменения для конечных пользователей системы (см. [требования](#changelog_entry_req)). Содержимое этого блока будет опубликовано в [списке изменений](../changelog-server.md), если PR будет замержен.
Copy link
Member

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 можно пропустить, так?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Поправила

Copy link

github-actions bot commented Feb 13, 2025

2025-02-13 20:11:50 UTC Pre-commit check linux-x86_64-release-asan for b739459 has started.
2025-02-13 20:12:01 UTC Artifacts will be uploaded here
2025-02-13 20:14:18 UTC ya make is running...
🟢 2025-02-13 20:14:23 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-02-13 20:14:29 UTC Build successful.

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Copy link

github-actions bot commented Feb 13, 2025

2025-02-13 20:12:45 UTC Pre-commit check linux-x86_64-relwithdebinfo for b739459 has started.
2025-02-13 20:12:57 UTC Artifacts will be uploaded here
2025-02-13 20:15:14 UTC ya make is running...
🟢 2025-02-13 20:15:19 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-02-13 20:15:25 UTC Build successful.

Copy link

github-actions bot commented Feb 14, 2025

2025-02-14 07:44:17 UTC Pre-commit check linux-x86_64-relwithdebinfo for e94aa62 has started.
2025-02-14 07:44:41 UTC Artifacts will be uploaded here
2025-02-14 07:47:44 UTC ya make is running...
🟢 2025-02-14 07:47:50 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-02-14 07:47:56 UTC Build successful.

Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Copy link

github-actions bot commented Feb 14, 2025

2025-02-14 07:47:32 UTC Pre-commit check linux-x86_64-release-asan for e94aa62 has started.
2025-02-14 07:47:45 UTC Artifacts will be uploaded here
2025-02-14 07:50:13 UTC ya make is running...
🟢 2025-02-14 07:50:19 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-02-14 07:50:25 UTC Build successful.

@blinkov blinkov merged commit 010e83f into ydb-platform:main Feb 14, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants