vaggdim / sitegr

unofficial di.ionio.gr greek site reloaded (with clean history)

Διαδικασία συνεισφοράς σε αυτό το έργο

• Για κάθε ένα από τα παραδοτέα της εργασίας (όπως τα ορίζει η σελίδα του μαθήματος σας) θα πρέπει να ανοίγετε ένα νέο θέμα και μετά την έγκριση του να δημιουργείτε ένα αίτημα ενσωμάτωσης, το οποίο θα πρέπει να αναφέρεται ρητά στο θέμα με την ένδειξη closes #IssueNo.

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

• Για τα προχωρημένα παραδοτέα, από το 3ο και μετά, το ιδανικό είναι να ανοίξετε ένα δικό σας νέο θέμα για κάτι που αξίζει να προστεθεί, αλλά, αν δεν υπάρχουν δικές σας ιδέες, μπορείτε να δείτε (ορφανές) ιδέες στο ιστορικό, σε κάθε περίπτωση τα θέματα-αιτήματα θα πρέπει να είναι μεγαλύτερης δυσκολίας από την απλή προσθήκη περιεχομένου και να περιλαμβάνουν αλλαγές σε layouts, includes, ή/και προσθήκη νέων plug-ins, καθώς και αλλαγές στο στυλ που είναι σε ξεχωριστό αποθετήριο.

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

• Για να μειώσουμε τα αιτήματα που απορρίπτονται θα πρέπει να δοκιμάζετε πρώτα τις αλλαγές και προσθήκες που κάνετε στο τοπικό αντίγραφο σας, αφού πρώτα ενεργοποιήσετε τις ρυθμίσεις στον δικό σας λογαριασμό netlify και στείλετε ένα ντέμο λινκ μαζί με το αίτημα. Το ντέμο λινκ είναι εντελώς απαραίτητο στην περίπτωση που έχετε κάνει αλλαγές και στο στυλ μορφοποίησης, γιατί αυτό βρίσκεται σε διαφορετικό αποθετήριο.

Τεκμηρίωση αποθετηρίου περιεχομένου και θέματος-στυλ

• Το αποθετήριο του περιεχομένου εδώ συνοδεύεται από αναλυτική τεκμηρίωση την οποία θα πρέπει να μελετήσετε ανάλογα με το είδος της συνεισφοράς που κάνετε (π.χ., αρχιτεκτονική, διαδικασία, κατηγορία περιεχομένου). Τα περισσότερα αρχεία βασίζονται στην τεχνολογία markdown με front-matter σε YAML, τα οποία θεωρούνται γνωστά ή είναι εύκολο να μελετήσετε την πολύ σύντομη τεκμηρίωση τους.

• Το στυλ μορφοποίησης της ιστοσελίδας βασίζεται στο minimalmistakes, το οποίο βασίζεται στο σύστημα κατασκευής στατικών ιστοσελίδων jekyll και βρίσκεται στο αποθετήριο minimal-ionio, το οποίο ενεργοποιείται με την τεχνολογία jekyll-remote-theme. Το αποθετήριο αυτό βασίζεται σε προηγούμενο έργο.

• Το αποθετήριο εδώ περιέχει μόνο το περιεχόμενο της ιστοσελίδας, ενώ στο αποθετήριο του στυλ μορφοποίησης (με την τεχνολογία jekyll remote theme) θα βρείτε τον κώδικα που μετατρέπει τα δεδομένα σε ιστοσελίδα για τον τελικο χρήστη. Η κατανόηση της αλληλεπίδρασης των παραπάνω τεχνολογιών είναι απαραίτητη κυρίως για τα δύσκολα θέματα, στα οποία το ζητούμενο είναι η συνεισφορά και στα δύο αποθετήρια (δεδομένα-κώδικας). Η κατανόηση και η δεξιότητες χρήσης αυτών των τεχνολογιών είναι κυρίως δική σας ευθύνη γιατί σε καμία περίπτωση δεν θεωρούμε αυτές τις τεχνολογίες κάτι ιδανικό που αξίζει μελέτη-διδασκαλία, απλά είναι κατί βολικό για να αναπτύξουμε γνώσεις και δεξιότητες σε άλλα θέματα (π.χ., συνεργασία, ανάπτυξη λογισμικού με εκδόσεις κώδικα, οπτικοποίηση με στυλ μορφοποίησης, κτλ)

Βαθμολόγηση

• Για την βαθμολόγηση, ανάλογα με το μαθήμα, θα πρέπει να γίνουν δύο ή περισσότερα πετυχημένα αιτήματα ενσωμάτωσης και ο βαθμός εξαρτάται από το επίπεδο δυσκολίας των αιτημάτων ενσωμάτωσης. Για παράδειγμα, η συνεισφορά σε δεδομένα (5-6) είναι περισσότερο για ζέσταμα και κατανόηση της λειτουργίας, τα πραγματικά ζητούμενα συνήθως απαιτούν την επεξεργασία αρχείων που περιέχουν στυλ-δομή (_layouts _includes) καθώς και κώδικα liquid (7), ενώ τα πιο δύσκολα επεκτείνουν το αρχικό θέμα με νέες λειτουργίες. Για την άριστη βαθμολόγηση (8+) θα πρέπει να γίνει ανάληψη πρωτοβουλίας (π.χ., σχολιασμός και αξιολόγηση σε θέματα άλλων), αποσφαλμάτωση, συγγραφή-συντήρηση της τεκμηρίωσης, καθώς και σημαντική επέκταση της λειτουργικότητας του συστήματος.

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

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

Σχετική βιβλιογραφία

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

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