GitHub - Συνεργασία απευθείας στο αποθετήριο

Η άμεση συνεργασία μέσω του GitHub είναι πρακτική, αν θέλετε να διορθώνετε τακτικά σελίδες, να δημιουργείτε νέα αρχεία Markdown ή να εργάζεστε με το CircusWiki-Vault σε έναν επεξεργαστή όπως το Obsidian.

Αν θέλετε απλώς να συνεισφέρετε ένα παιχνίδι, μια μέθοδο, ένα PDF, έναν σύνδεσμο ή μια διόρθωση, ο ευκολότερος τρόπος είναι συνήθως καλύτερος:

Επιστροφή στη Συνεισφορά

Τι χρειάζεστε¶

• Ένας δωρεάν λογαριασμός GitHub: https://github.com/join
• Προαιρετικά GitHub Desktop: https://desktop.github.com/
• Ένας επεξεργαστής κειμένου για αρχεία Markdown, για παράδειγμα Obsidian, VS Code ή ένας απλός επεξεργαστής

Το GitHub Desktop δεν είναι υποχρεωτικό, αλλά για πολλούς ανθρώπους είναι ευκολότερο από τη γραμμή εντολών.

Εύρεση του αποθετηρίου¶

Το δημόσιο αποθετήριο βρίσκεται εδώ:

https://github.com/nica-ev/circuswiki

Εκεί βρίσκονται τα πραγματικά αρχεία Markdown, οι εικόνες, οι μεταφράσεις και τα εργαλεία από τα οποία δημιουργείται η ιστοσελίδα.

Τρόπος εργασίας με λίγα λόγια¶

Η τυπική ροή εργασίας είναι:

1. Fork του αποθετηρίου στο GitHub.
2. Κλωνοποίηση του αντιγράφου σας στον προσωπικό σας υπολογιστή.
3. Πραγματοποίηση αλλαγών σε ένα νέο branch.
4. Επεξεργασία αρχείων ή δημιουργία νέων αρχείων Markdown.
5. Commit των αλλαγών.
6. Μεταφόρτωση του branch στο GitHub.
7. Άνοιγμα ενός Pull Request, ώστε η αλλαγή να μπορεί να ελεγχθεί και να ενσωματωθεί.

Βήμα προς βήμα με το GitHub Desktop¶

1. Fork του αποθετηρίου¶

Ανοίξτε το αποθετήριο CircusWiki στο GitHub:

https://github.com/nica-ev/circuswiki

Κάντε κλικ στο Fork. Αυτό δημιουργεί ένα δικό σας αντίγραφο του αποθετηρίου στον λογαριασμό σας στο GitHub. Σε αυτό το αντίγραφο μπορείτε να εργαστείτε χωρίς να αλλάξετε απευθείας το κύριο έργο.

2. Κλωνοποίηση του αποθετηρίου¶

Ανοίξτε το GitHub Desktop και επιλέξτε:

File -> Clone repository...

Επιλέξτε το fork σας του nica-ev/circuswiki και καθορίστε έναν φάκελο στον υπολογιστή σας.

Στη συνέχεια, θα έχετε ένα τοπικό αντίγραφο των αρχείων.

3. Δημιουργία ενός Branch¶

Για την αλλαγή σας, είναι καλύτερο να δημιουργήσετε ένα δικό σας branch, για παράδειγμα:

spiel-beschreibung-ergaenzen
link-korrigieren
neue-methode-balancieren

Ένα branch κρατά την εργασία σας ξεχωριστά από την κύρια έκδοση. Αυτό διευκολύνει τον μετέπειτα έλεγχο.

4. Επεξεργασία αρχείων¶

Τα δημόσια περιεχόμενα βρίσκονται κυρίως στους φακέλους γλώσσας κάτω από το docs/:

docs/de/
docs/en/
docs/es/
docs/pl/
...
docs/img/

Όλες οι γλώσσες είναι ισοδύναμες. Δεν υπάρχει κύρια γλώσσα στην οποία πρέπει να δημιουργούνται απαραίτητα νέο περιεχόμενο.

Αν δημιουργείτε μια νέα πρωτότυπη σελίδα, τοποθετήστε την στον φάκελο της γλώσσας στην οποία είναι γραμμένο το κείμενο. Ένα πρωτότυπο ισπανικό κείμενο ανήκει, για παράδειγμα, στο docs/es/, ένα γερμανικό στο docs/de/, ένα αγγλικό στο docs/en/.

Σημαντικό είναι το frontmatter στην αρχή του αρχείου. Εκεί πρέπει να είναι εμφανές ότι η σελίδα είναι πρωτότυπη, για παράδειγμα:

translation_status: original
translation_source_lang: es

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

Κατά την επεξεργασία, προσέξτε τα εξής:

• Μην διαγράφετε το frontmatter στην αρχή του αρχείου.
• Για νέες πρωτότυπες σελίδες, ορίστε translation_status: original και την κατάλληλη translation_source_lang.
• Διατηρήστε τους υπάρχοντες συνδέσμους όσο το δυνατόν περισσότερο.
• Μην δημοσιεύετε προσωπικά δεδομένα, κλειδιά API ή εσωτερικές σημειώσεις.
• Χρησιμοποιείτε εικόνες μόνο αν τα δικαιώματα χρήσης είναι σαφή.
• Κάντε μικρές, σαφείς αλλαγές αντί για πολύ μεγάλες, μικτές αλλαγές.

5. Commit των αλλαγών¶

Στο GitHub Desktop, βλέπετε τα τροποποιημένα αρχεία σας στην περιοχή Changes.

Γράψτε μια σύντομη περίληψη, για παράδειγμα:

Korrigiere Materialliste im Bewegungsspiel
Ergänze Sicherheitshinweis zu Beigoma
Füge neue Spielbeschreibung hinzu

Στη συνέχεια, κάντε κλικ στο Commit to <branch-name>.

6. Μεταφόρτωση των αλλαγών¶

Κάντε κλικ στο Push origin για να ανεβάσετε το branch σας στο GitHub.

7. Άνοιγμα ενός Pull Request¶

Το GitHub Desktop ή το GitHub στο πρόγραμμα περιήγησης προσφέρει στη συνέχεια τη δυνατότητα δημιουργίας ενός Pull Request.

Ένα Pull Request σημαίνει: Προτείνετε την αλλαγή σας στο κύριο αποθετήριο. Η αλλαγή ελέγχεται, ενδεχομένως σχολιάζεται και στη συνέχεια ενσωματώνεται ή επεξεργάζεται περαιτέρω.

Βασικές αρχές Markdown¶

Το Markdown είναι μια απλή μορφή κειμένου. Οι πιο σημαντικοί χαρακτήρες αρκούν για τις περισσότερες συνεισφορές:

# Μεγάλος τίτλος
## Επικεφαλίδα ενότητας

Κανονικό κείμενο με **έντονη γραφή** και *πλάγια γραφή*.

- Σημείο λίστας
- Άλλο σημείο λίστας

[Κείμενο συνδέσμου](https://www.example.com)

Αν κάτι δεν είναι σαφές¶

Η άμεση συνεργασία μέσω του GitHub δεν χρειάζεται να είναι τέλεια από την αρχή. Αν ανοίξετε ένα Pull Request και κάτι δεν είναι σωστό, αυτό μπορεί να διευκρινιστεί κατά την αναθεώρηση.

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