Καλώς ήρθατε στο έργο Shelldio και ευχαριστούμε για το ενδιαφέρον σας να συνεισφέρετε κώδικα, αλλαγές κ.α.
Σημείωση: Οι παρακάτω οδηγίες μπορεί να αλλάξουν οποιαδήποτε στιγμή, να προστεθούν ή και να αφαιρεθούν στοιχεία, χωρίς κάποια προειδοποίηση. Οφείλουμε όλοι μας να παρακολουθούμε τις οποιεσδήποτε αλλαγές που θα γίνονται commit στο παρόν αρχείο
Όταν θελήσετε να συνεισφέρετε στο Shelldio, συζητήστε αρχικά την αλλαγή που θέλετε να κάνετε ανοίγοντας ένα issue πριν υποβάλετε μια αλλαγή.
Σημειώστε ότι έχουμε έναν κώδικα δεοντολογίας, τον οποίο υποχρεούστε όλοι, μηδενός εξαιρουμένου να ακολουθούμε σε όλες τις αλληλεπιδράσεις μας με το έργο.
Για να υποβάλετε ένα αίτημα τροποποίησης του κώδικα, παρακαλούμε ακολουθείστε τα παρακάτω βήματα:
- Issue: Ανοίγετε ένα issue στο οποίο περιγράφετε τι θέλετε να κάνετε και γιατί θα πρέπει να ενσωματωθεί η αλλαγή που σκοπεύετε να στείλετε
- Fork: Κάνετε fork το αποθετήριο στον λογαριασμό σας και έπειτα clone στον υπολογιστή σας.
- Code: Κάνετε git checkout -b onoma-branch όπου και τροποποιείτε τα σημεία του κώδικα που σας ενδιαφέρουν για υποβολή. Το βήμα αυτό είναι κρίσιμο διότι ακολουθούμε το μοντέλο GitHub flow το οποίο θεωρούμε οτι διαβάσατε και κατανοήσατε.
- Push: Μόλις θεωρείτε ότι έχετε ολοκληρώσει τις αλλαγές, κάνετε commit χρησιμοποιώντας τον οδηγό στον παρακάτω πίνακα (π.χ. git commit -m "[FIX] Διόρθωση του issue #Αριθμός_issue") όπου ο αριθμός issue (σημειώστε το μαζί με το σύμβολο #) είναι ο αριθμός που αντιστοιχεί σε αυτό που ανοίξατε στο βήμα 1.
| Σχόλιο | Περιγραφή | Παράδειγμα git commit |
|---|---|---|
| [REFACTOR] | αλλαγές στην δομή, θέση στοιχείων και δεδομένων | git commit -m “[REFACTOR] χρήση while αντί for loop” |
| [FIX] | διόρθωση ανακοινωμένου issue για bugfix | git commit -m “[FIX] Διόρθωση του issue #Αριθμός_issue” |
| [FEATURE] | Προσθήκη νέου χαρακτηριστικού | git commit -m “[FEATURE] Προσθήκη που ζητήθηκε στο #Αριθμός_issue” |
| [DOC] | αλλαγή στα σχόλια, μηνύματα, κείμενο | git commit -m “[DOC] διόρθωση επεξήγησης” |
Συμβουλή: Να κάνετε συχνά commits που ξεχωρίζουν κάθε αλλαγή ώστε να είναι ευδιάκριτος ο σκοπός της αλλαγή (τι αλλάζω και γιατί το αλλάζω)
- Pull request: Τέλος αφού κάνετε git push origin onoma-branch, λογικά θα σας εμφανίσει αυτόματα ένα λινκ με το οποίο μπορείτε να μας στείλετε το pull request υποβάλλοντας μας έτσι τις όποιες αλλαγές. Στην σελίδα που θα ανοίξει γράψτε μια σύνοψη με την οποία περιγράφετε τις αλλαγές που μας στέλνετε.
Εάν συναντήσετε κάποιο πρόβλημα η χρειάζεστε κάποια βοήθεια, μπορείτε να αφήσετε σχόλιο στο issue που ανοίξατε για να το διευθετήσουμε.
Όλα τα παραπάνω είναι απαραίτητο να τα ακολουθούμε κατά γράμμα, για να μπορέσετε και εσείς αλλά και οι υπόλοιποι συμμετέχοντες να παρακολουθούν την πορεία των αιτημάτων σας.
Παρόλα αυτά, οι υπολογιστές, το cloud και ο κώδικας, καμιά φορά μπορεί να μας δυσκολέψει την προσπάθεια μας να συνεισφέρουμε, οπότε σε κάθε περίπτωση πάντα προτιμάμε την επικοινωνία με την οποία όλα τα εμπόδια διευθετούνται.
Ευχαριστούμε !