Πώς να κάνετε τις κριτικές κωδικών σας διασκεδαστικές (και όχι τρομερές)

Έχω κάνει το δίκαιο μερίδιο των κριτικών κώδικα. Με δίκαιο μερίδιο, εννοώ πολλά. Έχετε κάνει ποτέ μια αναθεώρηση κώδικα για ένα επικό χαρακτηριστικό; Εχω. Δεν ήταν μια υπέροχη εμπειρία, γιατί τη στιγμή που το 100ο αρχείο αναθεωρήθηκε, ήμουν ήδη κουρασμένος κοιτάζοντας τον κώδικα. Ήμουν τόσο κοντά στο να πηγαίνω "Yup, μου φαίνεται καλό" και μετά έδωσα την έγκρισή μου.

Αλλά έτσι δεν λειτουργούν οι κριτικές κώδικα. Μόλις ξεκινήσετε, πρέπει να τηρήσετε και να το τελειώσετε μέχρι το τέλος. Σίγουρα, μπορείτε να κάνετε διαλείμματα, αλλά μετά αρχίζετε να χάνετε το περιβάλλον και πρέπει να ξεκινήσετε ξανά από την αρχή, όπως αυτό:

Ωστόσο, διαχωρίζω. Ο πόνος δεν είναι αυτό που πρέπει να μιλήσω.

Λοιπόν, πώς το κάνουμε, για παράδειγμα, λιγότερο τρομερό; Πρώτον, ακόμη και πριν υποβάλετε το αίτημα έλξης, και ακόμη και πριν ξεκινήσουμε την κωδικοποίηση, θα πρέπει να κάνουμε ένα σημείο να αναλύσουμε τα χαρακτηριστικά σε ωραία μικρά κομμάτια. Η ανάπτυξη και η ανάπτυξη γίνονται γρηγορότερες, καθώς είναι πάντα πιο εύκολο να αναπτύξετε μια μίνι λειτουργία από μια επική. Αυτό καθιστά τις κριτικές κώδικα ευκολότερη και ταχύτερη στην εκτέλεση, καθώς οι αλλαγές είναι αρκετά μικρές.

Μεγάλος! Ελπίζω να σας άρεσε το άρθρο μου. Ας πάμε όλοι στο σπίτι…

Περίμενε, σταμάτα !

Αυτό ήταν για το πώς να το κάνεις λιγότερο τρομερό, αλλά πώς να το κάνεις διασκεδαστικό;

Χρησιμοποιώντας μιμίδια σε κριτικές κώδικα

Αποποίηση ευθυνών: τα ακόλουθα είναι οι δικές μου σκέψεις και όχι του εργοδότη μου.

Ήθελα απλώς να το ξεφύγω, γιατί αυτό μπορεί ενδεχομένως να είναι ένα αμφιλεγόμενο θέμα. Εν πάση περιπτώσει, κάνουμε τις κριτικές κώδικα μας χαλαρή με την προσθήκη meme.

Μπορώ να ακούσω το μάτι σου από εδώ! Ακούστε με όμως. Ποια καλύτερη εξήγηση από το να συνδέσεις με κάποιον άλλον που το εξήγησε με χαρά;

Είναι τόνος που τον βοηθά να διασκεδάσει τόσο ο αναθεωρητής όσο και το άτομο του οποίου ο κώδικας ελέγχεται. Ένα παράδειγμα θα ήταν το πρώτο «βασικό» μου image wallet. Παρατήρησα ότι ο Rubocop έλειπε μερικά διπλά κενά στα αρχεία μας, οπότε όταν κάποιος υπέβαλε ένα αίτημα τραβήγματος με μια δέσμη επιπλέον λευκού χώρου, δεν ήταν απαραίτητο να τους δοθεί ένα δόγμα.

Ήταν μια απλή εικόνα, αλλά το μήνυμα ήταν πολύ αποτελεσματικό. Θυμάμαι τους ανθρώπους να γελούν όταν το είδαν. Οι άνθρωποι δεν ήθελαν να «κολλήσουν», οπότε όλοι ήταν πιο προσεκτικοί στο επιπλέον κενό τους.

Ήταν ευκολότερο να ανοίξετε το πρόγραμμα εύρεσης, να σύρετε το doge σε ένα σχόλιο και να δημοσιεύσετε, αντί να πληκτρολογήσετε το απλό παλιό Please remove the extra whitespaceστο αίτημα έλξης (PR), ειδικά αν υπήρχαν πολλά doges.

Δεν θα μπορούσε να πυροδοτήσει;

Θα μπορούσε εντελώς. Δεν λέω ότι όλοι πρέπει να ακολουθούν την ομάδα μας. Εξαρτάται πραγματικά από την προσωπικότητα της ομάδας. Η μέση ηλικία των έξι ετών είναι η κατώτερη ηλικία μου, πράγμα που σημαίνει ότι οι περισσότεροι μπορούν να σχετίζονται με μιμίδια. Θα ήταν διαφορετική ιστορία αν η ομάδα σας έχει μέσο όρο ηλικίας σαράντα (εκτός αν φυσικά ήταν κάτοικοι 4chan ή είναι ενημερωμένοι με τα πιο πρόσφατα μιμίδια!).

Γνωρίζετε τους συμπαίκτες σας καλύτερα. Μετά από μερικούς μήνες να είμαστε ο ένας με τον άλλον (ειδικά επειδή ζευγαρώσαμε σχεδόν το 100% του χρόνου), κάναμε μια αίσθηση του χιούμορ του άλλου, για να το πούμε. Αυτό μας έκανε να νιώθουμε άνετα όταν βλέπουμε μιμίδια στα PR μας και απλά γελάμε γι 'αυτό (φυσικά, ενώ διορθώνουμε το πρόβλημα)

Ποια οφέλη λαμβάνετε από τα μιμίδια;

Λοιπόν, ένα πλεονέκτημα είναι ότι κάνει την κριτική πιο γρήγορη (τουλάχιστον για μένα). Το άτομο που υπέβαλε επίσης το PR κατανοεί πραγματικά τι πρέπει να κάνουν γρηγορότερα. Αντί να διαβάζετε μερικές λέξεις, βλέπετε μια εικόνα - και όλοι γνωρίζουμε ότι οι εικόνες μιλούν πιο δυνατά από τις λέξεις. Εδώ είναι μερικά παραδείγματα από το personal image wallet™:

Όταν βγάζω μια εικόνα για πρώτη φορά, προσθέτω μια περιγραφή / εξήγηση σχετικά με το τι πρέπει να κάνουν / διορθώσουν. Τα παραπάνω βασικά λένε αφαιρέστε τον παραπάνω κωδικό "παλαιού τύπου". Διέγραψε το. Κατάστρεψέ το!

Αυτό είναι ειδικό για το Ruby - ο pretzel dotχειριστής είναι βασικά μια συντόμευση για ένα try-catch. Απλώς επισημαίνω το απόσπασμα που χρειάζεται κουλουράκι και επικολλήστε αυτήν την εικόνα. Γρηγορα και ευκολα!

Αυτά τα δύο απλά χρησιμοποιώ εναλλάξιμα και ξανά, ΠΕΡΙΣΣΟΤΕΡΑ στο Ruby όπου προσθέτουμε πάντα το # frozen_string_literal: trueμαγικό σχόλιο στην κορυφή του αρχείου. Με το Rubocop στο τιμόνι, όμως, έχουμε δει όλο και λιγότερο την Έλσα και τον κ. Freeze. Εμφανίζονται επίσης για οποιαδήποτε σταθερά που χρειάζεται πάγωμα.

Αυτό είναι αρκετά απλό (ελπίζω). Όταν οι συνάδελφοι το βλέπουν αυτό, είναι ένα σημάδι ότι είχαν τυπογραφικό λάθος. Συνήθως επισημαίνω επίσης το τυπογραφικό λάθος, ώστε να είναι γρήγορο και εύκολο να το δείτε (και να το διορθώσετε).

Αυτά είναι μόνο μερικά από αυτά. Θυμηθείτε όμως, ότι κάτι είναι συνήθωςόχι καλό πράγμα. Επομένως, προσέξτε μόλις προσθέσετε τα μιμίδια σας. Είναι επίσης καλύτερο να μην προσθέσετε πάρα πολλά μιμίδια, καθώς μερικές φορές μπορεί να αποσπάσει την προσοχή. Η εύρεση της σωστής ισορροπίας τόνου και η απλή αποστολή του μηνύματος όσο το δυνατόν γρηγορότερα είναι ο καλύτερος τρόπος για να ολοκληρώσετε μια αίτηση έλξης.

Αυτό ήταν παιδιά

Εν κατακλείδι, εξαρτάται πραγματικά από εσάς εάν θέλετε να διασκεδάσετε ή απλώς να παραμείνετε σοβαροί και επαγγελματικοί στη δουλειά. Κάποιοι μπορεί να πιστεύουν ότι τα μιμίδια δεν είναι επαγγελματικά - και σίγουρα, στα επίσημα πράγματα που μπορεί να είναι. Κάποιος μπορεί να υποστηρίξει ότι ένα αίτημα έλξης μπορεί να είναι ή είναι επίσημο πράγμα που σχετίζεται με την εργασία, αλλά νομίζω ότι ισχύει μόνο αν το χρησιμοποιείτε για τεκμηρίωση ή κριτικές. Διαφορετικά, νομίζω ότι είναι «ελεύθερη ομιλία» (ναι, τράβηξε εκείνη την κάρτα!) Και πρέπει να ληφθεί ως έχει.

Για μένα, μεταφέρει αυτό που θέλω να πω: αφαιρέστε επιπλέον κενό διάστημα, διορθώστε την ορθογραφία, παγώστε μια σταθερά ή αφαιρέστε μια γραμμή ή γραμμές κώδικα. Δεν χρειάζεται να πληκτρολογώ πολύ, ο συνάδελφός μου δεν χρειάζεται να διαβάσει μια σειρά λέξεων ενάντια σε μια άλλη δέσμη λέξεων και ελαφρύνει τη διάθεση λίγο. Όλοι κερδίζουν! Με αυτό, θα τελειώσω με μια άλλη από τις εικόνες μου: