Meine Lieblings-Git-Commit-Nachricht

Meine liebste Commit-Nachricht besteht aus nur zwei Worten.

Ich benutze die Versionskontrolle – meistens Git – die ganze Zeit, selbst mit kleinen Skripten, die niemand außer mir jemals ansehen wird, auch wenn ich es wahrscheinlich nicht brauche. Ich mag es einfach. Etwas über die Verwendung von Versionskontrolle oder Quellcodeverwaltung oder wie auch immer Sie es nennen möchten, macht meinen Codierungsprozess reibungsloser.

Und mir ist etwas Interessantes aufgefallen, als ich in den letzten Jahren fast jeden Tag Code in irgendein Repository übertragen habe. Ich habe eine Commit-Nachricht, die ich immer und immer wieder verwende.

Es ist dies: „Code komprimieren“

Alles in Kleinbuchstaben, einfach so.

Das ist eine Kurzform… Ich werde es erklären. Stellen Sie sich vor, ich habe Code, der bereits funktioniert. Hat wahrscheinlich Unit-Tests (obwohl vielleicht nicht genug davon … ein anderes Thema). Aber es hat Unit-Tests, die bestehen, oder vielleicht nicht, weil das Skript einfach ist und ich nur manuell teste.

Also habe ich die Änderungen zum Repo hinzugefügt und bereits festgeschrieben. Es wird in einem (teilweise) funktionierenden Zustand begangen.

Dann mache ich es besser.

Was mache ich? Ich benenne Variablen, Funktionen und Methoden um, damit es besser lesbar (verständlicher) ist, wenn ich oder ein Teamkollege dies 11 Monate später ändern und mich nicht mehr erinnern, was damals in unseren Köpfen war. Ich nehme fünf oder 20 oder 100 Zeilen Code und vereinfache es. Damit daraus zwei oder sieben oder 35 Zeilen werden. Was auch immer ich ausschneiden kann.

Keine neuen Funktionen. Null Fortschritt bei der Funktionalität. Ich mache den Code einfach lesbarer, wartbarer oder anderweitig besser. Es ging von einem Arbeitszustand in einen anderen, gleichwertigen Arbeitszustand über. Eine komplett horizontale Bewegung.

Und dann git-add und git-commit. Mit der Meldung „Code komprimieren“.

Dies macht die Codebasis oft kleiner, was Codezeilen angeht. Auf eine Weise, die (vor allem) besser lesbar und wartbar ist. Funktioniert aber immer noch genauso gut.

Eleganter also.

Aber nicht immer. Das eigentliche Änderungsset *muss* die Codezeilen nicht reduzieren. Wenn ich die Namen von Bezeichnern ändere, hat das im Grunde keinen Einfluss auf die Codegröße. Verdammt, ich nehme vielleicht ein Dutzend Zeilen und während des Entschleierns sind es jetzt etwa 80 oder 200. Also komprimiere ich den Code nicht immer wirklich.

Aber egal, es ist eine Verbesserung.

Dies ist großartig in Ihrem eigenen privaten Zweig, wo Sie eine Zillion winziger Commits machen können und niemand es Ihnen schwer machen wird. Manchmal habe ich drei „Code Compression“-Commits hintereinander.

Ich tue dies so oft, so häufig, dass ich mich einfach für den Ausdruck „Code-Komprimierung“ entschieden habe, damit ich nicht darüber nachdenken muss, welche Nachricht ich schreiben soll. Es gibt wahrscheinlich einen besseren Namen dafür. Aber ich kann mich nicht die Mühe machen, diese Gewohnheit zu ändern. Das erfordert Willenskraft, und ich habe andere Gewohnheiten, die es wichtiger ist, sie zu ändern.

Aber vielleicht kommt dir die Idee.

Das Tolle an diesem Konzept:

Nur weil Sie wissen, dass Sie „Code Compress“ als Commit-Nachricht verwenden können,

bringt Sie automatisch dazu, darüber nachzudenken, wie Sie sich kontinuierlich VERBESSERN können

dein Code.

Versuchen Sie es noch heute. Denn du wirst Liebe die Ergebnisse.



Source by Aaron Maxwell

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.