Was bedeutet ‘nit’ in Code Reviews?

Was bedeutet nit in einem Code Review?

Gelegentlich können wir in Codereviews Kommentare wie diese finden:

auto result = std::make_pair<uint64_t, std::string>(64, "Hallihallo");;

nit: double semicolon

In einem Review bezeichnet “Nit” eine kleine Ungenauigkeit oder einen Fehler, der die Funktionalität des Codes nicht wesentlich beeinträchtigt, aber dennoch korrigiert werden sollte. Zum Beispiel ein Tippfehler in einem Kommentar, ein zu viel gesetzter Semikolon oder eine zusätzliche Leerzeile. Der Prüfer weist auf diesen Fehler hin, möchte aber wahrscheinlich nicht, dass Ihr den Pull-Request aufgrund dieser Kleinigkeit verzögert.

Und so sollten wir damit umgehen: Wenn Du noch an dem PR arbeitest, kannst Du das in einem der nächsten Commits beheben. Verzögere aber nicht die Integration der Funktion oder des Bugfixes nicht wegen dieser Kleinigkeit. Wir alle wissen, dass das Warten auf den CI Zeit in Anspruch nehmen kann, und wenn Du den CI für diese Kleinigkeit blockierst, werden einige Leute wahrscheinlich nicht sehr glücklich sein.

Um mehr über die in Code Reviews verwendete “Slang” zu erfahren, habe ich in diesem Blogpost (englisch) eine Liste zusammengestellt, in der Du Erklärungen zu Abkürzungen wie +1, WIP, lgtm und anderen findest.

Die englische Version dieses Posts findest Du hier.

Leave a Reply