コードレビューは、ソーシャルかつロジスティックなプロセスであり、感情的なプロセスでもあります。特に、Pull Requestレビューを受ける時には、「同僚は自分の仕事をどう思っているのだろうか？」「このフィードバックを踏まえて、何を改善すべきなのか？」「どうすれば、すべての懸念事項に対処できるのだろうか？」など、神経質になることがあります。
Atom 1.37 betaでは、できるだけ簡単にテキストエディタへ反映できるよう、レビューコメント機能をリリースしました。これにより、エディタの横にあるドックからレビューコメントを表示できるようになり、Pull Requestに対するレビュー体験が向上します。このドックでは、コメントとコード、またはテキストの間をシームレスに移動でき、フィードバックに応じた変更を簡単に実行できます。プログレスバーを確認することで、未対応のコメントがいくつ残っているかが分かり、コメントに対する対応漏れを防ぐことができます。
細部へのこだわり
GitHubは、レビュー時に便利な機能をさらに追加しました。
- コメントの解決：レビューコメントドックから、コメントスレッドを解決済みとしてマークできます。コメントスレッドを解決することでプログレスバーが進むので、進行状況が視覚的にわかるだけでなく、タスク終了に近づいているという満足感も得られます。
- diff形式の表示：ドックには、コメント部分の行が即座にdiff表示されます。さらにコンテキストが必要な場合は、diffを開くボタンをクリックすると、Pull Request全体のdiffが表示されます。
- コメントの展開と折りたたみ：コメントスレッドは非常に長くなる場合があるため、GitHubでは、ユーザーが最も有効な情報だけに集中できるようにしたいと考えました。レビューの概要コメントとコメントスレッドを折りたたんだり、展開したりすることで、不要な情報を非表示にできます。
- コメントのある行のハイライトとアイコン表示：コードやテキストにコメントが付いている場合、その行がハイライトされ、アイコンが表示されます。そのアイコンをクリックすることでドックが開き、そのコメントまでスクロールします。ただし、行の強調表示やアイコンの表示を行うには、GitHub for Atomにサインインし、表示しているブランチがチェックアウト済みで、Pull Requestに対応している必要があります。
- チェックアウトと更新：自分がチェックアウトしたブランチのものではないレビューであっても、コメントの表示が可能です。ただし、そのファイルに移動したり、解決済みとしてコメントをマークしたりすることはできません。Pull Requestのブランチをチェックアウトするには、レビュードックの上部にあるチェックアウトボタンを使うと便利です。更新アイコンをクリックすると、新しいコメントとレビューを表示できます。
デザインのイテレーション
Atomのコードレビューの以前のデザインは、エディタ内にGitHub.comを再構築したように見えました。
エディタを使っている時とブラウザーを使っている時では考え方が異なります。基本的に、コードやテキストの編集にはエディタを使います。そこで、GitHubはPull Requestレビューに対してこれまでとは違うアプローチを採用し、編集中心の操作を優先することにしました。長いコメントやスレッドの周囲でコードを編集するとコードを壊す恐れがあるため、インラインコメントではなく、コードやテキストの側にドックを設け、必要に応じて表示／非表示できるようにしました。
また、GitHubはユーザー調査を行い、ドックの新しいデザインが包括的で便利であることを検証しました。GitHub.comとエディタを切り替えることなくレビューコメントに対応できる手法は、調査に参加したユーザーに好評を得ました。
また、参加ユーザーから、「コメントに絵文字で反応することは、フィードバックが届いたことをレビュアーに知らせる重要な方法である」というコメントもありました。絵文字での反応は、感謝の気持ちやその仕事への評価を示す手段でもあります。また、絵文字によって、言外の意味の追加、口調の表現、より共感を伴ったコミュニケーションが可能になります。
さらに、コメントに返信する流れは、GitHubが考えていた以上に重要でした。コード作成者であるGitHubユーザーから、自身がレビュアーの懸念に対処したかどうかを尋ねられるようにして欲しいとリクエストがありました。これは、Pull Requestに対するレビューは双方向のやり取りであることに起因するリクエストです。GitHubではこの貴重なフィードバックを取り入れ、コメントへの返信や絵文字による反応を追加しました。
ソーシャルコンポーネントを使った機能は、残念ながら悪用される可能性があります。皆さんの安全を担保するため、コメントドックではGitHubユーザーが不正またはスパムであると報告したコメントテキストは非表示になります。また、悪用される可能性を減らすため、ローンチ前に、信頼できるGitHubのコミュニティやSafetyチームに機能レビューを依頼しました。
Atom 1.37 Betaをご利用ください
Atomのレビューコメントをいち早く利用するには、Atom 1.37 Betaをダウンロードしてください。フィードバックがある場合や、最新情報を受け取りたい場合は、Atomリポジトリをチェックしてください。
Atom1.37 Betaはこちらから利用できます。
