docs(contributing): add tips for faster PR reviews section (#723)

Add a new section with practical advice to help contributors get their
PRs reviewed and merged faster. Covers CLA signing (listed first as a
common blocker), CI checks, focused changes, clear descriptions, test
coverage, code style consistency, and prompt feedback responses.

Synced across all localized versions (en, zh-CN, ja-JP, ko-KR, ru-RU)
and the docs site (pages/src/content/docs/).
This commit is contained in:
kite 2026-08-05 11:10:15 +08:00 committed by GitHub
parent 6dc3eb0670
commit 2cf21d6790
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 108 additions and 0 deletions

View file

@ -188,6 +188,18 @@ feat(agent): add support for custom tool definitions
- 変更をお願いすることがあります — これは通常の協力的なプロセスであり、敵対的なものではありません。
- 承認されると、メンテナーがPRをマージします。
## PR を早くレビューしてもらうためのヒント
PR を素早くレビュー・マージしてもらいたいですか?以下のプラクティスが役立ちます:
- **CLA に早めに署名する** — 多くの初回コントリビューターが CLA ボットのコメントを見落として手続きが止まっています。ボットが表示されたらすぐに Contributor License Agreement に署名してください——CLA 未署名の PR はマージできません。
- **すべての CI チェックをパスさせる** — CI が失敗している PR はレビューされません。プッシュ前にローカルで `make test``make build` を実行して、問題を早期に発見してください。
- **変更を焦点を絞って小さく保つ** — 一つのことだけを行う PR は、無関係な変更が混在する PR よりもはるかにレビューしやすいです。小さい PR はレビューが早く、修正の往復も少なくなります。
- **明確で正確な説明を書く** — *何を*変更し、*なぜ*変更したかを説明してください。説明は実際の diff と一致している必要があります——両者が一致しないとレビュアーの信頼を失います。開発中にスコープが変わった場合は、レビュー依頼前に説明を更新してください。
- **動作変更にはテストを含める** — テストのない新機能やバグ修正は疑問を生じさせます。テストは正確性を示し、レビュアーが意図された動作を理解する助けになります。
- **既存のコードパターンに従う** — 周囲のコードのスタイル、命名規則、アーキテクチャに合わせてください。一貫性はレビュアーの認知負荷を減らし、スタイルのみのレビューコメントを避けられます。
- **フィードバックに迅速に対応する** — レビュアーが変更を求めた場合、素早く対応してレビューサイクルを短く保ちましょう。意見が異なる場合は、コメントを無視するのではなく、理由を説明してください。
## Contributor License AgreementCLA
コントリビューションをマージする前に、すべてのコントリビューターにAlibaba Open Source Contributor License Agreementへの署名をお願いしています。これにより、プロジェクトがライセンス条項の下で配布できることが保証されます。

View file

@ -193,6 +193,18 @@ feat(agent): add support for custom tool definitions
- 변경 요청이 있을 수 있습니다. 이는 일반적이고 협업적인 과정입니다.
- 승인되면 maintainer가 PR을 merge합니다.
## PR을 더 빠르게 리뷰받는 방법
PR이 빠르게 리뷰되고 merge되길 원하시나요? 다음 사항들이 도움이 됩니다:
- **CLA에 빨리 서명하세요** — 많은 첫 기여자들이 CLA bot의 comment를 놓쳐서 진행이 막힙니다. bot이 안내하면 즉시 Contributor License Agreement에 서명하세요 — CLA 미서명 PR은 merge할 수 없습니다.
- **모든 CI 검사를 통과시키세요** — CI가 실패한 PR은 리뷰되지 않습니다. push 전에 로컬에서 `make test``make build`를 실행하여 문제를 미리 발견하세요.
- **변경 사항을 집중적이고 작게 유지하세요** — 한 가지만 하는 PR이 관련 없는 변경이 섞인 PR보다 훨씬 리뷰하기 쉽습니다. 작은 PR일수록 리뷰가 빠르고 여러 차례 수정이 필요할 가능성도 적습니다.
- **명확하고 정확한 설명을 작성하세요***무엇을* 변경했고 *왜* 변경했는지 설명하세요. 설명은 실제 diff와 일치해야 합니다 — 둘이 맞지 않으면 리뷰어의 신뢰를 잃게 됩니다. 개발 중 범위가 변경되었다면, 리뷰 요청 전에 설명을 업데이트하세요.
- **동작 변경에는 테스트를 포함하세요** — 테스트가 없는 새 기능이나 버그 수정은 의문을 제기합니다. 테스트는 정확성을 보여주고 리뷰어가 의도된 동작을 이해하는 데 도움이 됩니다.
- **기존 코드 패턴을 따르세요** — 주변 코드의 스타일, 명명 규칙, 아키텍처와 일치시키세요. 일관성은 리뷰어의 인지 부하를 줄이고 스타일 관련 리뷰 코멘트를 방지합니다.
- **피드백에 신속하게 응답하세요** — 리뷰어가 변경을 요청하면 빠르게 처리하여 리뷰 주기를 짧게 유지하세요. 동의하지 않는 경우, 코멘트를 무시하지 말고 이유를 설명하세요.
## Contributor License Agreement (CLA)
모든 contributor는 Alibaba Open Source Contributor License Agreement에 서명해야 합니다. 이는 프로젝트가 license terms에 따라 배포될 수 있도록 하기 위한 절차입니다.

View file

@ -194,6 +194,18 @@ feat(agent): add support for custom tool definitions
- We may request changes — this is normal and collaborative, not adversarial.
- Once approved, a maintainer will merge your PR.
## Tips for Faster PR Reviews
Want your PR to be reviewed and merged quickly? These practices help:
- **Sign the CLA early** — Many first-time contributors get blocked because they miss the CLA bot comment. Sign the Contributor License Agreement as soon as the bot prompts you — your PR cannot be merged without it.
- **Ensure all CI checks pass** — PRs with failing checks will not be reviewed. Run `make test` and `make build` locally before pushing to catch issues early.
- **Keep changes focused and small** — A PR that does one thing well is far easier to review than one that mixes unrelated changes. Smaller PRs get reviewed faster and are less likely to require multiple rounds of revision.
- **Write a clear, accurate description** — Explain *what* changed and *why*. The description must reflect the actual diff — reviewers lose trust when the two don't match. If the scope shifted during development, update the description before requesting review.
- **Include tests for behavior changes** — New features or bug fixes without tests raise questions. Tests demonstrate correctness and help reviewers understand the intended behavior.
- **Follow existing code patterns** — Match the style, naming conventions, and architecture of the surrounding code. Consistency reduces cognitive load for reviewers and avoids style-only review comments.
- **Respond to feedback promptly** — When a reviewer requests changes, address them quickly to keep the review cycle short. If you disagree, explain your reasoning rather than ignoring the comment.
## Contributor License Agreement (CLA)
We require all contributors to sign the Alibaba Open Source Contributor License Agreement before we can merge your contributions. This ensures that the project can be distributed under its license terms.

View file

@ -194,6 +194,18 @@ feat(agent): add support for custom tool definitions
- Мы можем попросить внести изменения — это нормальная совместная работа, а не противостояние.
- После одобрения мейнтейнер смёржит ваш PR.
## Как ускорить рассмотрение вашего PR
Хотите, чтобы ваш PR был рассмотрен и принят быстрее? Следующие практики помогут:
- **Подпишите CLA заранее** — Многие контрибьюторы-новички застревают, потому что пропускают комментарий CLA-бота. Подпишите Contributor License Agreement сразу, как только бот предложит — PR без подписанного CLA не может быть принят.
- **Убедитесь, что все проверки CI пройдены** — PR с непройденными проверками не будет рассматриваться. Перед отправкой запустите `make test` и `make build` локально, чтобы выявить проблемы заранее.
- **Делайте изменения фокусированными и небольшими** — PR, который делает одну вещь хорошо, гораздо проще ревьюить, чем тот, который смешивает несвязанные изменения. Маленькие PR ревьюятся быстрее и реже требуют нескольких раундов правок.
- **Пишите чёткое и точное описание** — Объясните, *что* изменилось и *почему*. Описание должно соответствовать реальному diff — если они расходятся, ревьюер теряет доверие. Если объём работы изменился в процессе разработки, обновите описание перед запросом ревью.
- **Добавляйте тесты для изменений поведения** — Новые функции или исправления без тестов вызывают вопросы. Тесты демонстрируют корректность и помогают ревьюерам понять ожидаемое поведение.
- **Следуйте существующим паттернам кода** — Придерживайтесь стиля, соглашений об именовании и архитектуры окружающего кода. Единообразие снижает когнитивную нагрузку на ревьюера и позволяет избежать замечаний, касающихся только стиля.
- **Оперативно реагируйте на обратную связь** — Когда ревьюер запрашивает изменения, обработайте их быстро, чтобы сократить цикл ревью. Если вы не согласны, объясните свою позицию, а не игнорируйте комментарий.
## Лицензионное соглашение контрибьютора (CLA)
Прежде чем мы сможем принять ваш вклад, необходимо подписать Alibaba Open Source Contributor License Agreement. Это гарантирует, что проект может распространяться на условиях своей лицензии.

View file

@ -188,6 +188,18 @@ feat(agent): add support for custom tool definitions
- 我们可能会要求修改——这很正常,是协作而非对立。
- 一旦批准,维护者会合并你的 PR。
## 让你的 PR 更快被处理
希望你的 PR 尽快被审查和合并?以下做法会有所帮助:
- **尽早签署 CLA** — 很多首次贡献者因为忽略了 CLA bot 的评论而被卡住。一旦 bot 提示,请立即签署贡献者许可协议——未签署 CLA 的 PR 无法被合并。
- **确保所有 CI 检查通过** — CI 未通过的 PR 不会被审查。推送前请在本地运行 `make test``make build`,提前发现问题。
- **保持改动聚焦且精简** — 只做一件事的 PR 远比混杂无关改动的 PR 更容易审查。越小的 PR 审查越快,需要多轮修改的可能性也越低。
- **撰写清晰、准确的描述** — 说明改了*什么*以及*为什么*。描述必须与实际 diff 一致——两者不符会让审查者失去信任。如果开发过程中范围发生了变化,请在请求审查前更新描述。
- **为行为变更编写测试** — 没有测试的新功能或缺陷修复会引发疑问。测试能证明正确性,并帮助审查者理解预期行为。
- **遵循现有代码风格** — 与周围代码的风格、命名规范和架构保持一致。一致性降低审查者的认知负担,也避免纯风格相关的评论。
- **及时回应反馈** — 审查者提出修改意见后,请尽快处理以缩短审查周期。如果有不同意见,请解释你的理由而不是忽略评论。
## 贡献者许可协议CLA
我们要求所有贡献者在合并代码前签署阿里巴巴开源贡献者许可协议CLA。这确保项目可以在其许可条款下合法分发。

View file

@ -197,6 +197,18 @@ not switch rule-doc files.
5. **Fill in the PR template.** A maintainer will review, usually
within a few business days.
## Tips for Faster PR Reviews
Want your PR to be reviewed and merged quickly? These practices help:
- **Sign the CLA early** — Many first-time contributors get blocked because they miss the CLA bot comment. Sign the Contributor License Agreement as soon as the bot prompts you — your PR cannot be merged without it.
- **Ensure all CI checks pass** — PRs with failing checks will not be reviewed. Run `make test` and `make build` locally before pushing to catch issues early.
- **Keep changes focused and small** — A PR that does one thing well is far easier to review than one that mixes unrelated changes. Smaller PRs get reviewed faster and are less likely to require multiple rounds of revision.
- **Write a clear, accurate description** — Explain *what* changed and *why*. The description must reflect the actual diff — reviewers lose trust when the two don't match. If the scope shifted during development, update the description before requesting review.
- **Include tests for behavior changes** — New features or bug fixes without tests raise questions. Tests demonstrate correctness and help reviewers understand the intended behavior.
- **Follow existing code patterns** — Match the style, naming conventions, and architecture of the surrounding code. Consistency reduces cognitive load for reviewers and avoids style-only review comments.
- **Respond to feedback promptly** — When a reviewer requests changes, address them quickly to keep the review cycle short. If you disagree, explain your reasoning rather than ignoring the comment.
## Contributor License Agreement (CLA)
The project requires the Alibaba Open Source CLA. The first time you

View file

@ -185,6 +185,18 @@ CI は push のたびに同じ一式を実行するため、予期せぬ結果
両方を更新してください。
5. **PR テンプレートを記入してください。** メンテナーがレビューします。通常は数営業日以内です。
## PR を早くレビューしてもらうためのヒント
PR を素早くレビュー・マージしてもらいたいですか?以下のプラクティスが役立ちます:
- **CLA に早めに署名する** — 多くの初回コントリビューターが CLA ボットのコメントを見落として手続きが止まっています。ボットが表示されたらすぐに Contributor License Agreement に署名してください——CLA 未署名の PR はマージできません。
- **すべての CI チェックをパスさせる** — CI が失敗している PR はレビューされません。プッシュ前にローカルで `make test``make build` を実行して、問題を早期に発見してください。
- **変更を焦点を絞って小さく保つ** — 一つのことだけを行う PR は、無関係な変更が混在する PR よりもはるかにレビューしやすいです。小さい PR はレビューが早く、修正の往復も少なくなります。
- **明確で正確な説明を書く** — *何を*変更し、*なぜ*変更したかを説明してください。説明は実際の diff と一致している必要があります——両者が一致しないとレビュアーの信頼を失います。開発中にスコープが変わった場合は、レビュー依頼前に説明を更新してください。
- **動作変更にはテストを含める** — テストのない新機能やバグ修正は疑問を生じさせます。テストは正確性を示し、レビュアーが意図された動作を理解する助けになります。
- **既存のコードパターンに従う** — 周囲のコードのスタイル、命名規則、アーキテクチャに合わせてください。一貫性はレビュアーの認知負荷を減らし、スタイルのみのレビューコメントを避けられます。
- **フィードバックに迅速に対応する** — レビュアーが変更を求めた場合、素早く対応してレビューサイクルを短く保ちましょう。意見が異なる場合は、コメントを無視するのではなく、理由を説明してください。
## コントリビューターライセンス契約CLA
本プロジェクトは Alibaba Open Source CLA を必要とします。初めて PR を出すと bot がリンクを貼ります——

View file

@ -201,6 +201,18 @@ CI запускает тот же набор при каждой отправк
5. **Заполните шаблон PR.** Мейнтейнер проведёт ревью, обычно в течение
нескольких рабочих дней.
## Как ускорить рассмотрение вашего PR
Хотите, чтобы ваш PR был рассмотрен и принят быстрее? Следующие практики помогут:
- **Подпишите CLA заранее** — Многие контрибьюторы-новички застревают, потому что пропускают комментарий CLA-бота. Подпишите Contributor License Agreement сразу, как только бот предложит — PR без подписанного CLA не может быть принят.
- **Убедитесь, что все проверки CI пройдены** — PR с непройденными проверками не будет рассматриваться. Перед отправкой запустите `make test` и `make build` локально, чтобы выявить проблемы заранее.
- **Делайте изменения фокусированными и небольшими** — PR, который делает одну вещь хорошо, гораздо проще ревьюить, чем тот, который смешивает несвязанные изменения. Маленькие PR ревьюятся быстрее и реже требуют нескольких раундов правок.
- **Пишите чёткое и точное описание** — Объясните, *что* изменилось и *почему*. Описание должно соответствовать реальному diff — если они расходятся, ревьюер теряет доверие. Если объём работы изменился в процессе разработки, обновите описание перед запросом ревью.
- **Добавляйте тесты для изменений поведения** — Новые функции или исправления без тестов вызывают вопросы. Тесты демонстрируют корректность и помогают ревьюерам понять ожидаемое поведение.
- **Следуйте существующим паттернам кода** — Придерживайтесь стиля, соглашений об именовании и архитектуры окружающего кода. Единообразие снижает когнитивную нагрузку на ревьюера и позволяет избежать замечаний, касающихся только стиля.
- **Оперативно реагируйте на обратную связь** — Когда ревьюер запрашивает изменения, обработайте их быстро, чтобы сократить цикл ревью. Если вы не согласны, объясните свою позицию, а не игнорируйте комментарий.
## Лицензионное соглашение участника (CLA)
Проект требует подписания Alibaba Open Source CLA. При создании первого PR бот

View file

@ -181,6 +181,18 @@ CI 在每次推送时运行同一套,不会有意外。
(在 [`docs/`](https://github.com/alibaba/open-code-review))与任何相关内联帮助。
5. **填写 PR 模板。** 维护者会评审,通常几个工作日内。
## 让你的 PR 更快被处理
希望你的 PR 尽快被审查和合并?以下做法会有所帮助:
- **尽早签署 CLA** — 很多首次贡献者因为忽略了 CLA bot 的评论而被卡住。一旦 bot 提示,请立即签署贡献者许可协议——未签署 CLA 的 PR 无法被合并。
- **确保所有 CI 检查通过** — CI 未通过的 PR 不会被审查。推送前请在本地运行 `make test``make build`,提前发现问题。
- **保持改动聚焦且精简** — 只做一件事的 PR 远比混杂无关改动的 PR 更容易审查。越小的 PR 审查越快,需要多轮修改的可能性也越低。
- **撰写清晰、准确的描述** — 说明改了*什么*以及*为什么*。描述必须与实际 diff 一致——两者不符会让审查者失去信任。如果开发过程中范围发生了变化,请在请求审查前更新描述。
- **为行为变更编写测试** — 没有测试的新功能或缺陷修复会引发疑问。测试能证明正确性,并帮助审查者理解预期行为。
- **遵循现有代码风格** — 与周围代码的风格、命名规范和架构保持一致。一致性降低审查者的认知负担,也避免纯风格相关的评论。
- **及时回应反馈** — 审查者提出修改意见后,请尽快处理以缩短审查周期。如果有不同意见,请解释你的理由而不是忽略评论。
## 贡献者许可协议CLA
本项目要求 Alibaba Open Source CLA。首次开 PR 时会有 bot 贴链接——电子签署