Google コードレビュー・ガイドライン要約【コードレビューの基準編】
はじめに レビュー基準について再考する機会があり、調べていたところ、すばらしい記事を発見しました。 Google がコードレビュー・ガイドラインを公開しているようです。 有志の方による 日本語訳版 もありました。 今回は日本語訳版の内容を元に、筆者なりに概念をまとめてみました。 「Google コードレビュー・ガイドライン要約」シリーズとして、書いていきます。 シリーズ構成 ※リンクが貼られていない箇所は未要約です コードレビューの仕方 コードレビューの基準 ← here!! コードレビューの観点 コードレビューの進め方 コードレビューのスピード コメントの書き方 取り下げへの対応 CL 作成者のガイド 適切なディスクリプション 小さな CL レビューコメントへの対応 緊急事態の CL 本シリーズ通して 少し長くなりますが、本誌議の立ち位置を書いておきます。 気にならない方は 用語 まで飛
特に個人開発者向け！CodeRabbit(自動レビューツール)を使えばコードの健康まで得られることに気づいた話
特に個人開発者向け！CodeRabbit(自動レビューツール)を使えばコードの健康まで得られることに気づいた話 ↑by Image Creator from Microsoft Bing CodeRabbitのレビュー もう初回コードレビューはAIに任せる時代になった - CodeRabbit -を読んだ。レビューはとても負担が多く、時間もかかる。これをAIがやってくれたら、こんな有難いことはない。というわけですぐに使ってみた。 CodeRabbitを使った結論 結論から書くと、レスポンスも速く、技術レベルも高く、気を使う必要もない上に、コミュニケーションも出来る。若干問題に対して答えを言いすぎるキライはあるが、これも使い方に依る。さらにレビューを意識することでコードの健康まで得られてしまう。良いことしかない。 CodeRabbitの価格体系 気になっていたのはやっぱり価格だが、調べてみた
コードレビューにラベルを付けるだけでチームの心理的安全性を高めた話
ハコベルシステム開発部のおおいし (@bicstone) です。普段はフロントエンドエンジニアとして物流DX SaaSプロダクトの開発を行なっています。 この記事ではハコベルの開発チームが心理的安全性の向上を目的に採用した、プルリクエスト (マージリクエスト) コメントにラベルを付ける手法についてご紹介します。 背景 プルリクエストをレビューする時、レビュアーとして上から目線になってしまい相手を傷つけないか緊張したり、ちょっとした確認のつもりで書いたコメントが修正必須と捉えられてしまったりした経験はないでしょうか。 本来、ピアレビューは対等な関係であるはずなのに、レビューする側の方が上になってしまいお互いに恐縮してしまいがちです。「勘だと怪しいけど間違っていたら怖いから言えないな」や、「将来的に辛くなりそうな実装だけどわざわざ指摘するほどでもないな」など荒波を立てずにApproveしてしま
社内向けに「レビューのつらさを倒したい」という話をしました | DevelopersIO
prismatix事業部の塩谷 (@kwappa) です。 「＊＊会」について prismatix事業部では、毎週金曜日の朝10時から「＊＊会」というタイトルで誰かが喋る、という会を催しています。 もともとはマネジメント陣からプロダクトの導入状況や部署の状態、今後の方針などを説明する機会だったのですが、だんだん拡大していろんな話をしてもらうようになってきました。 ぼくも（ちょっと恥ずかしいのですが）「塩谷会」というタイトルで何度か話しています。その中のいくつかがDevelopersIOの登壇ネタになっていたりもするので、いいアウトプットの機会にもなっています。 「レビューのつらさを倒したい」 先日、塩谷会で「レビューのつらさを倒したい」という話をしました。見直してみると社内に閉じなければならない内容でもないので、スライドを公開してみます。 スライド 以下余談 この記事を書いたいきさつ 日々
良いコードとは何か - エンジニア新卒研修 スライド公開
株式会社サイバーエージェントの2021年度 エンジニア新卒研修でコードの品質に関する講義を行いました。 https://note.com/cyberz_cto/n/n26f535d6c575
コードリーディングのコツは極力コードを読まないこと｜牛尾 剛
私はクラウドのプロダクトチームで働いているが、何を隠そう一番苦手で克服できていないことが、コードリーディングだ。ものすごーく時間かかるし、時間かかったうえに読み間違えたりするし、しかもめっちゃ頭使うのに他の人はずっと速いので敗北感しか残らない。先日もマネージャの Pragna に相談したら、最初は２時間かかるけど、３か月もしたら５分で終わるわよ。って言われたけど、いや、そもそも俺４時間は最低かかるねんけどな、、、って感じ。 技術イケメンの皆さんのアドバイス よくよく私のキャリアを考えると、OSSにコントリビュートとかしていることはあったが、めっちゃくちゃ巨大でややこしいコードベースを読んで理解する必要が無いことが多かった。１からコードを書くのは得意だが、他の人のを読んでがっつり理解してとか、どうやったら出来るのかわからない。 当然自分の周りの技術イケメンの皆さんにコツを聞いていたのだが、ど
メンバーに恨まれそうな3つのコードレビュー施策を徹底したら、逆にメンバーが爆速で成長した話 - Qiita
ある程度経験を積んだレビュワーがやりがちな失敗は、 指摘しやすいコーディング規約違反だけ指摘している というもの。 コードレビューで指摘するべき欠陥とは、必ずしも規約違反だけではなく、 仕様考慮もれや機能的なバグ、非機能的なセキュリティやパフォーマンス上の問題点も含まれる。 一つ関数に対して複数の視点でソースチェックをしないといけないが、 人間は同時に複数のことは考えられない。 そこでどうすればいいかと情報をあさっていたところ、 われらがIPAがセキュアプログラミング講座というWEBページで、 四回に分けてレビューすることを提唱していた。 １回目はどこに何があるか、 ２回目は可読性が確保されているか、規約にのっとっているか ３回目は機能性 ４回目はセキュリティ といった具合である。 IPAの講座では４回目はセキュリティに限定しているが、 担当していたプロダクトは、非機能面はセキュリティはも
コードレビュー虎の巻 - Qiita
レビューガイドライン(Review GuideLine) ここで述べているレビューはピアレビューについての方法です。 （作業成果物の欠陥と改善の機会を探すレビュー） 「最悪を最初に」を基本としてレビューすべき、 たとえば、仕様やアルゴリズムに欠陥があるのに、typoにこだわってもしょうがないので、なにが最悪かを考え、それを防ぐための物からレビューをします。 誤りがプロダクト全体に影響し、手戻りのコストが高くつく、あるいは失敗するようなリスクがないかを考慮にいれてレビューの対象を選択します。 たとえば、基本的な初期フェーズの要求仕様や、クリティカルな決定の基礎になる仕様、使用頻度が高いモジュールなどを重点的にレビューします。 以下に書く項目はレビュアーに負担をかけないようにするのが前提なのでレビュアーに出す前にそもそもテストしたい項目です。 参考： あなたのおっしゃるレビューってどのことかし
Googleがコードレビューにおいてスムーズにコミュニケーションを進めるための注意点を公開
ソフトウェアの品質を保つためのツールとして、コードの変更点を一度他の人にチェックしてもらうという「コードレビュー」は高く評価されていますが、そのコードレビューにおいて、スムーズにレビューを進めるためのヒントをGoogleがブログに公開しています。 Google Testing Blog: Code Health: Respectful Reviews == Useful Reviews https://testing.googleblog.com/2019/11/code-health-respectful-reviews-useful.html ◆レビューする場合とされる場合の両方において守るべきこと ・相手の能力を尊重する 人が違えば得意分野や背景知識なども異なります。相手には高い能力があるはずだという前提に立ち、まずは質問を通して理解を深めることが大切です。 ・根拠を提示する ベスト
How to do a code review
How to do a code review The pages in this section contain recommendations on the best way to do code reviews, based on long experience. All together they represent one complete document, broken up into many separate sections. You don’t have to read them all, but many people have found it very helpful to themselves and their team to read the entire set. The Standard of Code Review What to Look For
ソフトウェア設計の言語化スキルを磨くこと｜qsona
たとえば設計について議論するときや、コードレビューで指摘をするときに、「なぜその設計が良いと思うのか？」について言語化するのが上手だと、確実に良いことがあります。 言語化が上手にできるかが一つの壁なのではないか、と感じることもあります。後輩を育てたりチームをリードするような立場になると、特に必要性を感じるのではないかなと。 自分も、うまく言語化できたことですんなり議論を進められていると感じることは多いですし、逆に直感的な良さを言語化できなかったことで直感に反する方向に進んでしまい、結果よくなかったというような苦い経験もあります。 前提: ソフトウェア設計の良さは静的には決まらない良い設計・良いコードとは何なのか。という質問に一言で答えるなら、「保守性が高い」ことだと思います。つまり、今後の変更・拡張を、高速にバグが少なく行えるような状態が良い設計・良いコードです。(一般的にはこれで70%く
レビュー支援ツール Lightning Review - 設計文書のレビューが簡単に、高品質に
レビュー支援ツールで、 誰でも毎日、直感的な設計レビューを。 見たままを"ダイレクト"に伝える レビューの状況が"一目"で把握できる 指摘・問題の"バラツキ"が見える
コードレビューのベストプラクティス | POSTD
Wiredrive では、私たちはかなりの数のコードレビューを行います。しかし、ここで働き始める前には私はコードレビューなどしたことがありませんでした。今回は、私がコードレビューをする時に何に注目するようにしているかや、私の考え出したベストなコードレビューのやり方をお話したいと思います。 コードレビューとは、簡単に言うと2人以上の開発者で問題を引き起こしそうなコードの修正について話し合うことです。コードレビューをすることのメリットについては多くの記事で語られており、知識を共有できること、コードのクオリティが上がること、開発者が成長できることなどが挙げられています。しかし、レビューを行う上で、どのように進めていくかという具体的なことについてはあまり多く語られてないように私は思いました。 レビューで何に注目するか アーキテクチャ/デザイン 単一責任原則 : 1つのクラスは変更する理由が2つ以上
コードレビュー ありがちな問題への対処例 - Crieit
コードレビュー、これまでいろんなプロジェクトで経験して、意外と使われていないノウハウがあったり、風習が違ってつらみがあったりしたので、いろいろまとめてみる。 指摘事項について よくある話 - 駄目コードを憎んで人を憎まず。駄目なのはコードであって人格じゃない - 指摘する人は人格攻撃せずにコードのどこが悪いのかを指摘しましょう - 指摘される人も、言われているのはコードの問題であって人間の問題じゃないので、素直な心で受け止めよう この辺はみんな知ってると思うので略。ぼくが思う大事なルール コードレビューで指摘された内容は、対応必須ではない 理由： 対応必須にすると、「これ言ったらリリースできなくなるよね」みたいな忖度が発生してコメントできない人が出現するから。 絶対ダメとは言わないけど、あまりよくはない、みたいな指摘については、そのときは急ぐからリリースするけど、次回から気をつけるとかがあ
人間らしくコードレビューするには(パート1) | Yakst
自動化することによりあなたはレビュアーとしてより価値のある貢献ができるようになります。importsの順序やソースコードのファイル名の命名規約などの問題を無視できるならば、機能上の誤りや可読性の問題といった、より関心のある問題にフォーカスすることができます。 オーサーもまた自動化の恩恵を受けます。ケアレスミスを見つけるのに1時間浪費することなく、即座に見つけられます。即座にフィードバックを受けられることで、関係のあることがオーサーの頭に残り、これにより学習が容易となり、修正コストが低くなります。それに加え、彼らが初歩的な誤りについて指摘を受ける必要がある場合、あなたから指摘を受けるよりコンピューターから指摘を受けたほうが彼らの自尊心の観点からはるかに気分がよいわけです。 これらの自動チェックはコードレビューのワークフローの中に入れましょう(例えば、Gitのコミット前のフックやGithubの
SNSに特化したソースコード共有サービス「ReviewMe」をリリースしました｜ちゃんなか
ReviewMeは、「誰でも気軽に技術発信が出来る」SNSに特化したソースコード共有サービスです。 ソースコードをReviewMe上に貼り付けると、SNSに投稿するためのOGP画像とURLが瞬時に自動生成され、誰でも気軽にソースコードをSNS上でシェアすることが出来ます。 何故ReviewMeを作ったのか プロトタイプを開発し、ユーザーインタビューしたところ、「レビューするハードルが高い」という意見が多かった一方で、 「その日書いたコードの記録を残したい」「コード共有するのはカンタンで楽」という意見が多く、早々に、技術発信にフォーカスしたソースコード共有サービスにピボットする意思決定をしました。 （ユーザーインタビューに付き合ってくれ方々、本当にありがとうございました🙇） 早くユーザーの反応を見たかったので、現時点では最小限の機能だけまず作ってリリースしましたが、 今後、ポートフォリオ機
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
レビューの仕方
コードレビュー研修
GitHub - Aloxaf/silicon: Create beautiful image of your source code.
google/codesearch: Fast, indexed regexp search over large file trees
