Ευχαριστούμε που θέλεις να συνεισφέρεις στο Exercism!
Πριν δημιουργήσεις ένα pull request, διάβασε τον οδηγό πώς να φτιάξεις ένα εξαιρετικό pull request, που στοχεύει να σε βοηθήσει με τη μη τεχνική πλευρά των pull requests, ώστε να έχεις μια εξαιρετική εμπειρία και ταυτόχρονα να βοηθήσεις την ομάδα συντήρησής μας.
Αυτό το έγγραφο περιέχει μερικές επιπλέον οδηγίες ειδικά για το Exercism, για διαφορετικούς τύπους pull requests.
Pull requests για ασκήσεις
Η δημιουργία ενός pull request για ένα Concept Exercise ή ένα Practice Exercise μπορεί να είναι αποθαρρυντική, με τόσους πολλούς κανόνες γύρω από αυτούς τους τύπους ασκήσεων.
Για αυτόν τον λόγο, ένας συντηρητής μπορεί να χρειαστεί δύο με τρεις ώρες για να το ανασκοπήσει, και η ανασκόπηση μπορεί να καταλήξει σε δεκάδες σχόλια.
Για να σε βοηθήσουμε, θα υπάρχει ένας κύριος ανασκοπητής που θα σχολιάζει το pull request σου.
Μην αποθαρρύνεσαι από τον αριθμό των σχολίων ανασκόπησης. Είναι απολύτως φυσιολογικό μια άσκηση να περάσει από αρκετές επανεγγραφές πριν φτάσει σε κάτι με το οποίο θα είστε και οι δύο ευχαριστημένοι: εσύ και ο κύριος ανασκοπητής.
Συστάσεις
Ακολουθούν μερικές συστάσεις που θα βοηθήσουν να γίνει η διαδικασία ακόμα πιο ομαλή.
Διάβασε την τεκμηρίωση
Πριν δημιουργήσεις ένα pull request για μια άσκηση, φρόντισε να διαβάσεις την τεκμηρίωση για τα Concept Exercises ή αντίστοιχα την τεκμηρίωση για τα Practice Exercises.
Το να διαβάσεις την τεκμηρίωση εκ των προτέρων βοηθάει πάρα πολύ, καθώς οι ανασκοπήσεις θα έχουν λιγότερα σχόλια και το pull request σου θα συγχωνευτεί πολύ πιο γρήγορα.
Εξέτασε τις υπάρχουσες ασκήσεις (αν υπάρχουν)
Αν το track έχει ήδη ασκήσεις, αφιέρωσε λίγο χρόνο για να τις μελετήσεις, ώστε να δεις πώς μοιάζουν και πώς είναι δομημένες.
Pull requests για Practice Exercises
Σκέψου αν η αλλαγή ανήκει πραγματικά στο problems-specifications
Μέρος του περιεχομένου ενός Practice Exercise (όπως η εισαγωγή του) προέρχεται από τα (κοινόχρηστα) μεταδεδομένα του, όπως ορίζονται στο αποθετήριο problems-specifications.
Αν σκοπεύεις να ενημερώσεις τέτοιο περιεχόμενο, σκέψου αν η αλλαγή θα μπορούσε να ωφελήσει και άλλα tracks.
Αν ναι, άνοιξε καλύτερα ένα pull request στα μεταδεδομένα της άσκησης στο αποθετήριο problems-specifications.
Γενικές συστάσεις
Απέφυγε να κάνεις ανασκοπήσεις που δεν σου ζητήθηκαν
Όλες οι ανασκοπήσεις pull requests γίνονται από έναν (ή περισσότερους) συντηρητές του track, καθώς αυτοί είναι υπεύθυνοι για την έγκριση όλων των αλλαγών στο αποθετήριο.
Το να κάνουν οι συντηρητές την ανασκόπηση βοηθά επίσης να αποφευχθούν αντικρουόμενα σχόλια για τον δημιουργό του pull request.
Φυσικά, μπορείς κάλλιστα να αφήσεις ένα σχόλιο για να προσφέρεις βοήθεια με την ανασκόπηση (ειδικά σε μεγαλύτερα pull requests) ή να θέσεις ερωτήσεις, αν παρατηρήσεις κάτι που μοιάζει με λάθος.
