How to Code Review

Kannste schon so machen, aber dann isses halt...

Autor: jasie | twitter.com/ja_sie • mail@jasie.de

Download: how-to-code-review_jasie_2022_v4.pdf (3.21 MB)

Abstract

Im Netz findet man viele Quellen zum Thema Sinnhaftigkeit von Code Reviews sowie zu dafür nutzbaren Tools. Jedoch gibt es kaum Informationen, worauf man bei manueller Qualitätsprüfung von Code eigentlich konkret achten soll und wie man dabei methodisch vorgehen kann.
Ich werde die vielseitigen Aspekte systematisch vorstellen und beleuchten. Als Reviewing-Noob wirst du dich dann vielleicht nicht mehr so "verloren" fühlen (wie ich damals), als erfahrener Reviewer hoffentlich dir bisher unbekannte Aspekte entdecken. Und wer noch gar kein Code Reviewing praktiziert, kann feststellen, wie ungeheuer wertvoll dies sei kann.

Tools

  1. GitHub Pull Requests: github.com/features/code-review
  2. Gitlab Merge Requests: docs.gitlab.com/ee/user/project/merge_requests
  3. Crucible (Atlassian): atlassian.com/software/crucible
  4. Bitbucket (Atlassian): bitbucket.org/product/de/features/code-review
  5. StackExchange Code Review: codereview.stackexchange.com

Quellen

  1. The Upsource Blog: What to look for in a Code Review | Trisha Gee, 2015
    blog.jetbrains.com/upsource/2015/07/23/what-to-look-for-in-a-code-review/ ff
    leanpub.com/whattolookforinacodereview
  2. The Upsource Blog: Code Review Best Practices | Trisha Gee, 2018
    blog.jetbrains.com/upsource/2018/08/30/code-review-best-practices/
  3. The Overflow: How to Make Good Code Reviews Better | Gergely Orosz, 2019
    stackoverflow.blog/2019/09/30/how-to-make-good-code-reviews-better/
  4. itemis: 10 Best Practices für Code-Reviews, die Spaß machen | Sascha Bleidner, 2019
    blogs.itemis.com/10-best-practices-fuer-code-reviews-die-spass-machen
  5. How to Do Code Reviews Like a Human | Michael Lynch, 2017
    mtlynch.io/human-code-reviews-1/
  6. Atlassian: Why code reviews matter (and actually save time!) | Dan Radigan
    atlassian.com/agile/software-development/code-reviews
  7. sd&m Conference: Reviews and inspections / A History of Software Inspections | Michael Fagan, 2001
    mfagan.com/pdfs/software_pioneers.pdf
  8. The Space Blog: Best Code Review Tools for 2022 ‒ Survey Results | Evgenia Verbina, 2021
    blog.jetbrains.com/space/2021/12/15/best-code-review-tools
  9. OWASP Code Review Guide | Larry Conklin and Gary Robinson
    owasp.org/www-pdf-archive/OWASP_Code_Review_Guide_v2.pdf
  10. Medium: Code Reviews Code of Conduct | Matti Bar-Zeev, 2018
    medium.com/front-end-weekly/code-reviews-code-of-conduct-6c78a026ed35
  11. Characteristics of Useful Code Reviews: An Empirical Study at Microsoft | A. Bosu, M. Greiler, C. Bird, 2015
    amiangshu.com/papers/CodeReview-MSR-2015.pdf
  12. Heise: Nachgebessert: Pull-Request-Workflows in der Praxis | Jan Petzold, 2019
    heise.de/ratgeber/Nachgebessert-Pull-Request-Workflows-in-der-Praxis-4341944.html