Project

General

Profile

Actions

Προδιαγραφές κώδικα

Οι υποβολές των αλλαγών που γίνονται στο κώδικα θα πρέπει να τηρούν τις ακόλουθες προδιαγραφές:

Συμβατότητα

Διατήρηση της συμβατότητας με τα υπόλοιπα υποσυστήματα της πλατφόρμας.
Τυχόν αλλαγές που γίνονται στη βάση θα πρέπει να συνοδεύονται με πλήρη τεκμηρίωση των τυχόν καινούριων πινάκων/πεδίων της βάσης μαζί με το κατάλληλο script αναβάθμισης ενσωματωμένο στο upgrade.php.

Τήρηση των κανόνων ασφαλείας

Ιδιαίτερη προσοχή έτσι ώστε ο χρήστης/φοιτητής να μην μπορεί να εκτελεί ενέργειες που δεν επιτρέπονται. Ασφάλεια θα πρέπει να υπάρχει και στο "Διαχειριστικό Εργαλείο της Πλατφόρμας".

Τεκμηρίωση

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

Αντίστοιχο on-line help

Κάθε καινούριο υποσύστημα θα πρέπει να συνοδεύεται από το αντίστοιχο on-line help. Επίσης, θα πρέπει να υπάρχουν περιγραφές του υποσυστήματος για ενσωμάτωσή του στα εγχειρίδια.

Επιτυχημένη λειτουργία

Είναι επιθυμητή η αναφορά επιτυχημένης λειτουργίας σε όσο το δυνατόν περισσότερες εκδόσεις λειτουργικών συστημάτων (π.χ. Windows XP/2000/2003/Vista/2007, UNIX/Linux) και εκδόσεων PHP (εκδόσεις >= 5.3), Apache (>= 2.x), MySQL (εκδόσεις >= 5.x.). Αν υπάρξουν τυχόν ασυμβατότητες σε συγκεκριμένες εκδόσεις PHP, Apache, MySQL (πάντα σε εκδόσεις μεγαλύτερες από τις προαναφερθέντες) θα πρέπει να αναφέρονται καθώς και να δικαιολογούνται.

Συμβατότητα με τους δημοφιλέστερους browsers

Ο καινούριος κώδικας θα πρέπει να είναι συμβατός με τους πιο δημοφιλείς browsers (π.χ. Internet Explorer εκδόσεις μεγαλύτερες του 7, τελευταίες εκδόσεις του Firefox κ.λπ.)

Updated by Yannis Exidaridis over 10 years ago · 2 revisions