Pull Requests

Πώς να φτιάξεις ένα εξαιρετικό Pull Request


Τα Pull Requests (PRs) είναι ο τρόπος με τον οποίο υποβάλλεις τις προτεινόμενες αλλαγές σου σε κάποιο κομμάτι της βάσης κώδικα του Exercism. Αν το διαβάζεις αυτό και ετοιμάζεις ένα PR, σε ευχαριστούμε! Αυτός ο οδηγός στοχεύει να σε βοηθήσει με τη μη τεχνική πλευρά των PR, ώστε να έχεις μια εξαιρετική εμπειρία και να βοηθήσεις ταυτόχρονα την ομάδα των maintainers μας.

Τι να περιμένεις

Η διαδικασία για τα PR είναι η εξής:

  • Υποβάλλεις ένα PR
  • Ένας ή περισσότεροι maintainers ελέγχουν το PR, αφήνοντας προτεινόμενα σχόλια. Σε ορισμένες περιπτώσεις, μπορεί να συζητήσουν το PR στο σύνολό του, για να καταλάβουν αν είναι σωστό αυτό που προστίθεται.
  • Το PR σου γίνεται merge και κερδίζεις Reputation στον ιστότοπο. Ή το PR σου κλείνει.

Πώς κάνω το PR μου να γίνει merge;

Υπάρχουν κάποια πράγματα που μπορείς να κάνεις από πριν, ώστε να είναι πιο πιθανό το PR σου να γίνει merge με τις λιγότερες δυνατές αλλαγές.

Το πιο σημαντικό είναι να βεβαιωθείς πριν υποβάλεις το PR ότι οι maintainers θα καλωσορίσουν τις αλλαγές που κάνεις. Ο πιο εύκολος τρόπος για να το κάνεις αυτό είναι να ανοίξεις πρώτα ένα Issue στο GitHub, εξηγώντας τι σκοπεύεις να κάνεις και ρωτώντας αν οι maintainers είναι ανοιχτοί σε αυτές τις αλλαγές.

Note

Αν βρεις ένα Task στον ιστότοπο του Exercism, τότε δεν χρειάζεται να ανοίξεις καινούργιο Issue. Μπορείς να σχολιάσεις στο υπάρχον Issue ότι θα το αναλάβεις και μετά να προχωρήσεις.

Το δεύτερο πράγμα που πρέπει να φροντίσεις είναι να αφήσεις μια σαφή περιγραφή μέσα στο PR όταν το ανοίγεις. Τα PR χωρίς περιγραφή είναι απίστευτα απογοητευτικά για τους maintainers, αφού δεν έχουν το πλαίσιο όταν διαβάζουν τον κώδικα. Πες μας γιατί έκανες τις αλλαγές, βάλε σύνδεσμο προς το Issue στο οποίο αναφέρεται το PR, εξήγησε τυχόν συμβιβασμούς που χρειάστηκε να κάνεις, κ.λπ.

Τέλος, φρόντισε το PR σου να περιέχει μόνο αλλαγές που σχετίζονται με μία βελτίωση. Αν έχεις πολλές βελτιώσεις, χώρισέ τες σε πολλαπλά PR. Έτσι οι maintainers μπορούν να τα ελέγξουν πιο εύκολα και πιο γρήγορα, και η ζωή σου θα γίνει πιο εύκολη κι εσένα.

Πόσο καιρό πρέπει να περιμένω;

Συνήθως οι maintainers θα ελέγξουν το PR σου μέσα σε λίγες μέρες. Παρακαλούμε μην ανεβάζεις συνέχεια το PR με επιπλέον σχόλια την πρώτη εβδομάδα. Οι maintainers μας είναι εθελοντές και πολυάσχολοι άνθρωποι και θα το ελέγξουν όσο πιο σύντομα μπορούν. Αν δεν έχεις λάβει απάντηση μέσα σε 7 μέρες, κάνε tag το @exercism/reviewers σε ένα νέο σχόλιο στο PR, και έτσι θα ειδοποιηθεί μια ευρύτερη ομάδα.


Σε ευχαριστούμε και πάλι για τη συνεισφορά σου στο Exercism. Ελπίζουμε να είναι μια διασκεδαστική και πολύτιμη εμπειρία!