Gerrit/Code review/Getting reviews/ja


 * To learn about reviewing code from others check the tutorial and the Code review guide.

コードの変更をより速くレビューしてもらい、受理される可能性を高めるにはどうしたらいいでしょうか?

要件

 * バグを修正したり、新しい機能を追加するために、あなたが変更したコードがあること.
 * You have followed the Coding conventions.
 * You have followed the Pre-commit checklist.
 * You have followed the.
 * You have a to use with Gerrit and successfully set up Git/Gerrit on your machine.

さて、あなたはパッチを作成して Gerrit にアップロードし、コードのレビューとマージ (コード ベースへの取り込み) を受けようと計画しています.



あなたのパッチ


スコープの範囲内かどうか事前に確認
If your proposed code changes do not fix a bug but introduces a new feature instead, speak first to the maintainers to make sure that your idea is in the project scope and that your proposed technical approach is the optimal solution. これを行うことで、時間の節約と潜在的な失望を削減できます.



あなたの変更をテストする
Test your changes in your development environment to make sure there are no compilation errors or test failures. 何らかの理由でパッチをテストしていない場合は、Gerrit のコメントでその旨を明示してください. Consider going through the Pre-commit checklist.

不完全な修正や新たなバグを発生させないようにしましょう. あなたのパッチにもっと作業が必要だとわかっている場合は、Gerrit で「-2」としてレビューするか、コミット メッセージに「[WIP]」 (work in progress: 作業進行中) の接頭辞をつけるなどして、明示的にその旨を伝えてください.



小規模なパッチを書く
小規模で独立していて完全なパッチが、より受け入れられやすいのです.

コミットが別々のファイル群に変更を加えるものであり、その間にあまり依存関係がない場合は、より小さな個別のコミットとしたほうがいいかもしれません.

さらに、パッチに不必要な変更 (例えば、コーディング スタイルの修正など) を含めないように注意してください.

However, if your commits are going to be touching the same files repeatedly, bundle them up into one large commit (using either  or squashing after the fact).



意味のあるコミット メッセージを書く
コミット メッセージでは内容と理由を説明すべきです. 何が問題点でしたか? それをどのように解決しましたか? 正しく動作することをテストする方法は? 詳細は を参照してください.

また、コミット メッセージは必ず校正し、正しい綴りや句読点を使用するようにしましょう.



説明文書を追加
パッチに含まれる機能がエンド ユーザーや管理者の目に見えるようになる場合、関連する説明文書を更新または作成するようにしてください. See Development policy#Documentation policy for more information.



リベースと変更を混同しない
When rebasing, only rebase. リベース以外の変更がリベースの変更セット内で行われた場合、それを見つけるためにさらに多くのコードを読み通さなければならず、明白ではありません. 実際に変更を行う場合は、変更内容を説明する Gerrit コメントを残し、コミットの要約が正確であることを確認して訂正します.



あなたの作業


テストの失敗やフィードバックへの対応
Check your Gerrit settings and make sure you're getting email notifications. If your code fails automated tests, or you got some review already, respond to it in a comment or resubmission.

(自動テストが失敗した理由を見るには、Gerrit の「失敗」コメントのリンクをクリックし、失敗したテストの赤い点にカーソルを合わせ、ポップアップが表示されるまで待ち、「コンソール出力」をクリックします. )

Feedback will usually (but not always) come with a C-2, C-1, C+1, or C+2 flag from Gerrit. You can read more about what these mean (from the reviewer's perspective) at Gerrit/Code review#Complete the review. レビュアーの中には、新人投稿者を安心させるために、明示的な C-1 評価を用いずに改善点を指摘する人もいます. それでも彼らの提案を真摯に受け止めるべきでしょう.

時には、あなたが無関係と認識するようなレビュー、例えば単なる表面的なレビューが届くこともあります. そのようなレビューを無視するのではなく、些細な要望を満たすためにパッチを修正しましょう. あなたは反対するかもしれませんが、議論するには譲歩するよりも時間を消費します.

コード レビューとは、選挙に勝つことではなく、合意形成の問題です. あなたは、否定的なフィードバックに対処することが期待されており、肯定的なレビューをさらに求めて「反対票を投票」(outvote) することはできません. ネガティブなフィードバックに対処するためには、必ずしもパッチを変更する必要はありません - 時には、必要なのはよりよい説明だけです. しかし、そのような場合でも、コミット メッセージやコード内のコメントにその説明を盛り込むことで、同じ悩みを持つ将来のメンテナーによりよい情報を提供できます.

一般的に: 我慢をして成長してください. より経験豊富なパッチ執筆者は、より早く、より肯定的な反応を得ることができます.



レビュアーを追加
レビュアーの選択は、レビュー時間に重要な役割を果たします. より活発なレビュアーが、より迅速な反応を提供します.

コミットした直後に、変更セットに 1 人か 2 人の開発者をレビュアーとして追加してください. (これらはリクエストです. Gerrit では特定の 1 人にレビューを割り当てる方法はありません. ) 経験豊富な開発者はこれを支援すべきです: 未レビューの変更セットが残っていることに気づいた場合は、レビュアーを追加してください. レビュアーを見つける方法は以下の通り:


 * Check the main maintainers list, or the maintainers listed in the extension's page, to find who's currently maintaining that part of the code, or is in maintainer training.
 * Click the magnifying glass in the "Project" row of your gerrit patch. Now find other changesets in that repository: the people who write and review those changesets would be good candidates to add as reviewers. Or see who can approve your patch: click "Access" in the top navigation bar, click the link(s) in "Owner" rows, see the list of names.
 * To find out who added a system message and why, see Special:MyLanguage/Gerrit/Navigation for specific advice.
 * Search through other commit summaries and changesets. Navigate the repository tree to your repository or directory and click "View History" to see who is active in the area, for instance changes in the database of MediaWiki core. Or search on Gerrit: Matma Rex and Foxtrott are interested in reviewing frontend changes, so you can search for "message:css" to find changesets that mention CSS in their commit summaries to add them to. You can use this and regexes to find changes that touch the same components you're touching, to find likely reviewers (search docs).



さらにレビューする
Many eyes make bugs shallow. Read the Code review guide and help other authors by praising or criticizing their commits. コメントは、拘束力を持たず、マージや却下の原因にはならず、コード レビューに正式な影響を与えません. しかし、レビューすることで学び、評判が上がり、将来あなたのコード変更案をレビューすることで恩返しをする人が現れるでしょう. "How to review code in Gerrit" has the step-by-step explanation.



想定される障害への対応


タイムリーなフィードバックがない
フリー ソフトウェアやオープン ソース ソフトウェアのプロジェクトでは人手が限られており、開発者の関心も変化する可能性があります. コード リポジトリの中には、より活発でメンテナンスされているものもあり、より迅速なレビューを受けられます. また、保守管理者が不明確な場所や、廃墟のような場所もあり、長い時間待たされることもあります.

You can check the latest activity in a code repository by looking at the "Recent Commits" list of the repository in Diffusion or via  in your local checkout. To take over an abandoned project and become its maintainer, follow these steps.

If you think that your patch has been gone unnoticed for a longer time, feel free to bring up the problem on the IRC channel.



手直しや却下のその他の理由
すべての推奨事項に従ったとしても、パッチは手直しが必要な場合があります (まれに却下される場合もあります).

既に述べたこと以外にも、より単純で効率的な方法がある場合の最適でない解決策、パフォーマンスの問題、セキュリティの問題、(変数などの) 名前付けの改良、既存のコードとの統合の衝突、作業の重複、API の意図しない (誤った) 使用、内部 API の変更案がリスクが高すぎると見なされた、などの拒否の理由 (すべてが同様に決定的なものとは限らない) は潜在的に存在します.

判断の不一致に注意してください: パッチのレビュアーは、テストの失敗、不完全な修正、新しいバグの発生、最適でない解決策、矛盾した説明文書などを、パッチを却下する決定的な要因として考えることが、パッチの作成者よりも多いのです.



関連項目

 * "5 tips to get your code reviewed faster"
 * "Code review meeting notes" (from 2012; relevant parts are now included in the present documentation)