プル リクエストのコードをレビューする
コード レビューは、プル リクエストのプロセスや、開発プロセス全体で不可欠な要素であり、組織や同僚に次のようなメリットをもたらします。
- 知識の共有—すべてのコードが有識者によって確認されるため、すべての開発者が新しい領域に取り組んだり、フィードバックを受け取ったりする機会を活用できます。
- 品質保証—経験豊富な開発者であっても、常に学習が必要です。コードをほかのユーザーに確認してもらうことで、品質が最高レベルであることを保証できます。
- 指導の機会 — コードベースに参加したばかりの新しいユーザーは、習熟したメンバーからのフィードバックでさまざまなことを学べます。
プル リクエストでのコードのレビューには、変更の確認と元のコードとの比較を行うことに加えて、コメントやフィードバックを追加してコードのディスカッションを開始する、2 つの要素があります。プル リクエストのレビューの詳細については、「プル リクエストのコードをレビューする」の「レビュワー」をご参照ください。
ファイルの差分の確認
Each pull request shows a diff of each file to compare the updates made to the repository and the repository or branch where the author wants to merge.
Setting your default viewing preferences
Access the pull request.
- Click on the Viewing preferences settings (cog) icon located in the upper-right corner above the file(s).
- Update your viewing preferences.
- 保存をクリックします。
Viewing preferences
- Diff view - Set your default diff view preference to either unified or side-by-side.
- Ignore whitespace - Enable to remove any changes in the file that involve spaces and tabs from the diff view, by default.
- Enable word diff - Enable to display a darker shade of color on lines that have been updated or changed.
- Enable color accessibility - Enable to change the background color of the diff to more visually accessible colors for people with color blindness.
- Load files individually - Enable to individually display files in a pull request, by default, regardless of size.
In the new pull request experience, we’ve added the Load files individually setting to your Viewing preferences. When enabled, any pull request you view will display files individually regardless of the size of the pull request. When disabled, only pull requests with 8,000 or more lines will display files individually - this is to help optimize the loading process and ensure the files are loaded and displayed successfully.
Setting viewing preferences for each file
From each file, you can set the following viewing preferences from the More options... dropdown menu which can be accessed by clicking the More options... (meatball) button in the upper-right corner of the file.
| ラベル | 説明 |
|---|---|
| View side-by-side | コードの変更を 2 列で表示します。左側の列 (前バージョン) には元のコードが、右側の列 (新バージョン) には更新内容が表示されます。 |
| View entire file | Opens the entire file in a separate modal which allows you to view the entire file and make comments throughout. |
| Open in source | Opens the file in the Source view. You'll see the full file and can make edits from Bitbucket. |
| コメントを追加 | プル リクエストでファイルにコメントを追加します。プル リクエストにコメントを追加する他の方法については、「コメントの追加」を参照してください。 |
| Collapse all files | Collapses all the files in the diff view. |
| Expand all files | Expands all the files in the diff view. |
If you have not opted in to the new pull request experience, these settings will be located under Files changed on the Overview tab, you have a unified diff that shows the changes in one column by default.
コードのディスカッションとフィードバック
コメントの追加やディスカッションは、コード レビューのプロセスで大きな割合を占めます。作成者やレビューアがコメントを追加したりディスカッションに返信した後、作成者はプル リクエストの承認を完了するために追加のコミットをプッシュする場合があります。
リポジトリへの書き込みアクセス権を持つすべてのユーザーが、プル リクエストでコメントを追加できます。プル リクエストには 3 段階のコメント レベルがあります。
- プル リクエスト全体
- 個別ファイル
- コードの個別行
インライン コメントが表示できない場合
コメントがユーザーによって削除されている場合を除き、コメントは引き続き存在しています。行のコンテンツが削除されると、コメントを利用できなくなります。この場合、ファイル差分画面の上部にある数字のボタンを探します。このボタンをクリックすると、前のバージョンのすべてのコメントが表示されます。
コメントを追加する
リポジトリへの書き込みアクセス権を持つすべてのユーザーが、プル リクエストでコメントを追加できます。
各レベルでコメントを追加するには次の操作を実行します。
- Pull request – Under Comments on the pull request, click in the Add a comment text field. Add your comment and click Save.
- File - Click the More options... (meatball) button in the upper-right corner of the file > click Add comment. Add your comment to the text field and click Save.
- Inline - Scroll the mouse pointer over (or tab to) the line of code where you would like to leave a comment > click on the + icon that is displayed between the line number and the line of code. Add your comment to the text field and click Save.
If you have not opted in to the new pull request experience, below are the ways in which you can leave comments on a pull request.
- プル リクエスト—[概要] タブの [コメント] で、"What do you want to sat?" と表示されているテキスト フィールドをクリックします。
- ファイル—ファイル差分の上部にある [コメント] ボタンをクリックします。
- Inline — Click the Add a comment to this line button next to the line.
コメントのフォーマット方法
Use the WYSIWYG editor toolbar.
他ユーザーへのメンション方法
@ 記号を入力して対象のユーザー名を入力 / 選択することで他のユーザーにメンションできます。
コメントでのアクションの実行
コメントの下部に表示されるリンクを使用して次のようなオプションを利用できます。
- Reply - Keeps the conversation going by opening another comment field.
- Edit - Reopens the comment field so you can make your updates and click Comment again. You can only edit your own comments.
- Delete - Permanently removes the comment from the pull request. Deleting a comment also removes it from the Activity.
- Like - Click to like the comment.
- Create task - Click to create a task for yourself or someone else who is a reviewer on the pull request.
Viewing and accessing comments on pull requests
You can always view comments on a pull request or inline with the file or a specific line of code, but you can also view comments inline with the other actions taken on the pull request in Activity on the right sidebar.
- Click on the link associated with the comment to be taken to the comment in the diff file.
- You can filter by My comments and All comments on the Activity feed.
- Outdated comments open in a new modal.
タスクの作成
要求された変更を追跡するために、コメントに 1 つまたは複数のコメントを追加できます。コメント作成者に限らず、すべてのユーザーがコメントからタスクを作成できます。タスクを作成することで、プル リクエストの作成者に、コード更新の一環として完了する必要がある作業の一覧を提供することができます。
リポジトリ管理者は、プル リクエストのマージ前にすべてのタスクを完了させるようにする、マージ チェックリスト項目を設定できます。
| レビューアが実行できる操作 | 作成者とリポジトリ管理者が実行できる操作 |
|---|---|
| |
|
|
タスクの作成手順は次のとおりです。
At the comment level: If the exact text you want to use for a task is in the comment, highlight the text and click Create task. Otherwise, click Create task under the comment, enter the task description, and click Save. These comments are contextual, so when you click on the link icon associated with the task in the right sidebar Tasks list, the comment will be highlighted on the pull request.
At the pull request level: Click on Create a task at the bottom of the Task card on the right sidebar. Type or add the task to the text field. Press Enter (Return) to save the task.
プル リクエストでのタスク一覧の確認方法
Tasks are listed in the Task panel on the right sidebar. You can also find tasks listed in context in the Activity on the right sidebar.
If you have not opted in to the new pull request experience, below are the ways in which you can create and view tasks on a pull request.
- プル リクエスト—[概要] タブの [コメント] で、"What do you want to sat?" と表示されているテキスト フィールドをクリックします。
- ファイル—ファイル差分の上部にある [コメント] ボタンをクリックします。
- Inline — Click the Add a comment to this line button next to the line.
Viewing tasks on pull requests
右側のメタデータ セクションでタスクへのリンクを見つけます。このリンクは、[2 open tasks] や [All tasks resolved] のように表示されます。リンクをクリックすると、すべてのオープンなタスクと解決されたタスクを表示されます。このオプションは、プル リクエストにタスクが含まれる場合にのみ表示されます。