So machen Sie Ihre Codeüberprüfungen unterhaltsam (und nicht schrecklich)

Ich habe meinen fairen Anteil an Codeüberprüfungen durchgeführt. Mit fairem Anteil meine ich viel. Haben Sie jemals eine Codeüberprüfung eines epischen Features durchgeführt? Ich habe. Es war keine großartige Erfahrung, denn als die 100. Datei überprüft werden sollte, war ich bereits müde, Code zu betrachten. Ich war so nah dran, einfach „Ja, sieht gut aus für mich“ zu sagen und dann meine Zustimmung zu geben.

Aber so funktionieren Codeüberprüfungen nicht. Sobald Sie begonnen haben, müssen Sie sich daran halten und es bis zum Ende beenden. Sicher, Sie können Pausen einlegen, aber dann verlieren Sie den Kontext und müssen von vorne beginnen, wie folgt:

Ich schweife jedoch ab. Der Schmerz ist nicht das, worüber ich sprechen soll.

Wie machen wir es zum Beispiel weniger schrecklich? Bevor wir die Pull-Anfrage stellen und bevor wir mit dem Codieren beginnen, sollten wir zunächst darauf achten, Features in schöne kleine Teile zu zerlegen. Entwicklung und Bereitstellung werden schneller, da es immer einfacher ist, eine Mini-Funktion bereitzustellen als eine epische. Dies erleichtert und beschleunigt die Durchführung von Codeüberprüfungen, da die Änderungen relativ gering sind.

Toll! Ich hoffe dir hat mein Artikel gefallen. Lass uns alle nach Hause gehen ...

Warte, hör auf !

Das war ungefähr so, wie man es weniger schrecklich macht, aber wie wäre es damit, es lustig zu machen?

Verwenden von Memes in Codeüberprüfungen

Haftungsausschluss: Das Folgende sind meine eigenen Gedanken und nicht von meinem Arbeitgeber.

Ich wollte das nur aus dem Weg räumen, weil dies möglicherweise ein kontroverses Thema sein kann. Wie auch immer, wir machen unsere Codeüberprüfungen unbeschwert, indem wir Memes hinzufügen.

Ich kann dein Auge von hier rollen hören! Hör mir doch mal zu. Was gibt es Schöneres, als auf jemanden zu verlinken, der es gerne schon erklärt hat?

Es ist ein Ton, der sowohl dem Prüfer als auch der Person, deren Code geprüft wird, Spaß macht. Ein Beispiel wäre die allererste "Heftklammer" in meinem image wallet. Ich bemerkte, dass Rubocop einige doppelte Leerzeichen in unseren Dateien fehlte. Wenn also jemand eine Pull-Anfrage mit einer Menge zusätzlicher Leerzeichen einreichte, war es ein Kinderspiel, ihnen einen Dogen zu geben.

Es war ein einfaches Bild, und dennoch war die Botschaft sehr effektiv. Ich erinnere mich an Leute, die lachten, als sie es sahen. Die Leute wollten nicht "verfolgt" werden, deshalb waren alle in ihrem zusätzlichen Leerzeichen wachsamer.

Es war einfacher, den Finder zu öffnen, den Dogen in einen Kommentar zu ziehen und zu posten, anstatt nur das alte Please remove the extra whitespacein die Pull-Anfrage (PR) einzugeben, insbesondere wenn mehrere Dogen vorhanden waren.

Könnte es nicht nach hinten losgehen?

Es könnte total. Ich sage nicht, dass jeder unserem Team folgen sollte. Es hängt wirklich von der Persönlichkeit des Teams ab. Unser Durchschnittsalter beträgt sechs Jahre, mein Junior, was bedeutet, dass sich die meisten auf Meme beziehen können. Es wäre eine andere Geschichte, wenn Ihr Team ein Durchschnittsalter von vierzig Jahren hätte (es sei denn, sie waren natürlich Einwohner von 4chan oder sind mit den neuesten Memes auf dem neuesten Stand!).

Sie kennen Ihre Teamkollegen wirklich am besten. Nach ein paar Monaten, in denen wir miteinander waren (vor allem, weil wir fast 100% der Zeit gepaart hatten), hatten wir sozusagen ein Gefühl für den Humor des anderen. Dies machte es uns angenehm, Memes in unseren PRs zu sehen und nur darüber zu lachen (natürlich während wir das Problem behoben haben).

Welche Vorteile erhalten Sie von Memen?

Ein Vorteil ist, dass die Überprüfung dadurch schneller wird (zumindest für mich). Die Person, die auch die PR eingereicht hat, versteht tatsächlich, was sie schneller tun muss. Anstatt ein paar Wörter zu lesen, sehen Sie ein Bild - und wir alle wissen, dass Bilder lauter sprechen als Wörter. Hier einige Beispiele aus meinem personal image wallet™:

Wenn ich zum ersten Mal ein Bild herausbringe, füge ich eine Beschreibung / Erklärung hinzu, was sie tun / reparieren müssen. Das oben Gesagte besagt im Grunde, dass der oben genannte "Legacy" -Code entfernt werden soll. Lösche es. Zerstöre es!

Dies ist spezifisch für Ruby - der pretzel dotOperator ist im Grunde eine Abkürzung für a try-catch. Ich hebe nur das Snippet hervor, das eine Brezel benötigt, und füge dieses Bild ein. Schnell und einfach!

Diese beiden verwende ich nur austauschbar und immer wieder, meistens in Ruby, wo wir immer den # frozen_string_literal: truemagischen Kommentar oben in die Datei einfügen . Mit Rubocop an der Spitze haben wir jedoch immer weniger von Elsa und Mr. Freeze gesehen. Sie erscheinen auch für jede Konstante, die eingefroren werden muss.

Das ist ziemlich einfach (hoffe ich). Wenn Kollegen dies sehen, ist dies ein Zeichen dafür, dass sie einen Tippfehler hatten. Normalerweise hebe ich auch den Tippfehler hervor, damit er schnell und einfach zu sehen (und zu beheben) ist.

Dies sind nur einige davon. Denken Sie jedoch daran, dass normalerweise zu viel von etwas vorhanden istkeine gute Sache. Sei also vorsichtig, wenn du deine Memes hinzufügst. Es ist auch am besten, nicht zu viele Meme hinzuzufügen, da dies manchmal ablenken kann. Das Finden der richtigen Tonbalance und das Senden der Nachricht so schnell wie möglich ist der beste Weg, um eine Pull-Anfrage abzuschließen.

Das war's Leute

Zusammenfassend liegt es wirklich an Ihnen, ob Sie Spaß haben oder einfach nur ernsthaft und professionell bei der Arbeit bleiben möchten. Einige mögen Memes für unprofessionell halten - und sicher, in formalen Arbeiten. Man kann argumentieren, dass eine Pull-Anfrage eine formale arbeitsbezogene Sache sein kann oder ist, aber ich denke, dass sie nur gilt, wenn Sie sie für Dokumentation oder Überprüfungen verwenden. Ansonsten denke ich, dass es "Redefreiheit" ist (yep, habe diese Karte gezogen!) Und sollte einfach so genommen werden, wie es ist.

Für mich vermittelt es, was ich sagen möchte: Entfernen Sie zusätzliche Leerzeichen, korrigieren Sie die Rechtschreibung, frieren Sie eine Konstante ein oder entfernen Sie eine oder mehrere Codezeilen. Ich muss nicht viel tippen, mein Kollege muss nicht ein paar Wörter gegen ein anderes Wort lesen, und das hellt die Stimmung ein wenig auf. Jeder gewinnt! Damit beende ich dies mit einem weiteren meiner Bilder: