Skip to content

Commit 436b5bc

Browse files
skpanagiotisskpanagiotis
committed
Update Contributing.md
1 parent fbf798d commit 436b5bc

File tree

1 file changed

+97
-32
lines changed

1 file changed

+97
-32
lines changed

‎CONTRIBUTING.md

Lines changed: 97 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,19 @@ Eυχαριστούμε πολύ για το ενδιαφέρον σας να σ
1212

1313
Πριν ξεκινήσετε με την πρώτη σας μετάφραση θα θέλαμε να μοιραστούμε [κάποιες γενικές οδηγίες](#γενικές-οδηγίες).
1414

15-
## Βήμα 1: Github Setup
15+
## Περιεχόμενα
1616

17-
Πρέπει να κάνετε αυτό το βήμα μόνο μία φορά. Με το συγκεκριμένο fork μπορείτε να κάνετε όσα PR θέλετε.
17+
1. [Προετοιμασία](#preparation)
18+
2. [Συνεισφορά](#contributing)
19+
1. [Μετάφραση Αρχείου](#file-translation)
20+
2. [Αξιολόγηση Μετάφρασης](#translation-review)
21+
3. [Λερώστε τα χέρια σας! Μεταφράστε!](#start-translation)
1822

19-
1. Για να υποβάλετε μια μετάφραση, πρέπει να έχετε ένα fork του repository, κάνοντας κλικ στο κουμπί με την κόκκινη γραμμή από κάτω (για περισσότερες πληροφορίες δείτε [εδώ](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)). Αυτό σας επιτρέπει να δημιουργήσετε ένα προσωπικό αντίγραφο του repository για να δουλέψετε και να κάνετε αλλαγές πάνω σε αυτό:
23+
<h2 id="preparation">Προετοιμασία</h2>
24+
25+
Αυτό γίνεται μόνο μία φορά. Σκόπος είναι η δημιουργία ενός προσωπικού αντιγράφου του έργου. Με το συγκεκριμένο fork μπορείτε να κάνετε όσα PR θέλετε.
26+
27+
1. Για να υποβάλετε μια μετάφραση, πρέπει να έχετε ένα fork του repository, κάνοντας click στο κουμπί fork όπως φαίενται παρακάτω (για περισσότερες πληροφορίες δείτε [εδώ](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)). Αυτό σας επιτρέπει να δημιουργήσετε ένα προσωπικό αντίγραφο του repository για να δουλέψετε και να κάνετε αλλαγές πάνω σε αυτό:
2028

2129
![fork](/public/assets/fork-image.png)
2230

@@ -52,30 +60,61 @@ env\Scripts\activate.bat # Windows
5260
pip install -r requirements.txt
5361
```
5462

55-
## Βήμα 2: Ποια αρχεία πρέπει να μεταφραστούν;
63+
<h2 id="contributing">Συνεισφορά</h2>
64+
65+
Έχουμε [μια λίστα με issues στο GitHub](https://github.com/pygreece/python-docs-gr/issues?q=is%3Aissue+is%3Aopen+label%3Atranslation) όπου συντονίζουμε τη δουλειά που γίνεται ή που πρέπει να γίνει ώστε να γίνεταια διαχωρισμός αρμοδιοτήτων και διαχείριση της δουλειάς και των απαιτούμενων ενεργειών.
66+
67+
Οι τρόποι συνεισφοράς στο έργο είναι δύο:
68+
69+
<h3 id="file-translation">Μετάφραση Αρχείου</h3>
5670

57-
Έχουμε [μια λίστα με issues στο GitHub](https://github.com/pygreece/python-docs-gr/issues?q=is%3Aissue+is%3Aopen+label%3Atranslation) όπου συντονίζουμε τη δουλειά που γίνεται ώστε να μην μεταφραστεί το ίδιο έγγραφο δύο φορές. Η διαδικασία μετάφρασης ενός αρχείου είναι η εξής:
71+
Μπορείτε να συνεισφέρετε στην μετάφραση ενός αρχείου από αυτά που θα βρείτε στα [issues](https://github.com/pygreece/python-docs-gr/issues?q=is%3Aissue+is%3Aopen+label%3Atranslation).
72+
73+
Η διαδικασία μετάφρασης ενός αρχείου είναι η εξής:
5874

5975
- Επιλέξτε οποιοδήποτε από τα issues που δεν έχουν ανατεθεί σε κάποιο άλλο άτομο.
6076

61-
- Αφήστε ένα σχόλιο για στο issue λέγοντας ότι θέλετε να το δουλέψετε.
77+
- Αφήστε ένα σχόλιο στο issue λέγοντας ότι θέλετε να συνεισφέρετε αναλαμβάνοντας το συγκεκριμένο **Issue**.
6278

63-
- Περιμένετε έναν διαχειριστή να σας αναθέσει το issue.
79+
- Περιμένετε έναν διαχειριστή να σας αναθέσει το **Issue**.
6480

6581
- Ξεκινήστε τη μετάφραση!
6682

67-
Σημειώστε πως όλα τα translation issues είναι χωρισμένα σε δύο milestones:
83+
Τα **Issues** είναι χωρισμένα σε milestones:
84+
85+
To milestone που μπορείτε να συνεισφέρετε είναι το `translate_3.12_additional`. Άμα είναι η πρώτη σας φορά σε αυτό το έργο ή γενικότερα σε έργο ανοιχτού λογισμικού είναι προτιμότερο να αναλάβετε ένα **Issue** με **label** _good first issue_.
86+
87+
Επίσης, για διευκόλυνση, έχουμε κάνει μια κατηγοριοποίηση των **Issues** με βάση το μέγεθος (γραμμές κώδικα/ προς μετάφραση). Πιο αναλυτικά:
88+
89+
- `small` για αρχεία με λιγότερες από _200_ γραμμές
90+
- `medium` για αρχεία με λιγότερες από _500_ γραμμές
91+
- `large` για αρχεία με λιγότερες από _1000_ γραμμές
92+
- `xlarge` για αρχεία με λιγότερες από _2500_ γραμμές
93+
- `god` (για τους τολμηρούς) για αρχεία με περισσόρερες από _2500_ γραμμές
6894

69-
- Το πρώτο milestone ονομάζεται `translate_3.12_mvp` και όλα τα issues μέσα σε αυτό είναι τα απαραίτητα ώστε να δημοσιευτεί η μετάφραση.
70-
- Το δεύτερο milestone ονομαζεται `translate_3.12_additional` και όλα τα issues μέσα σε αυτό είναι προεαιρετικά.
95+
<h3 id="translation-review">Αξιολόγηση Μετάφρασης</h3>
7196

72-
Ιδανικά θα θέλαμε πρώτα να ολοκληρώσουμε το `translate_3.12_mvp` milestone και εν συνεχεία να μεταφράσουμε όλα τα issues του `translate_3.12_additional`.
97+
Μπορείτε να συνεισφέρετε κάνοντας μια αξιολόγηση των ήδη μεταφρασμένων αρχείων, για τυχόν παρατηρήσεις, βελτιώσεις, ελλείψεις ή διορθώσεις στην μετάφραση.
7398

74-
## Βήμα 3: Ξεκινήστε τη μετάφραση!
99+
Η διαδικασία είναι:
75100

76-
1. Διαλέξτε το αρχείο που θέλετε να μεταφράσετε. Το αρχείο θα υπάρχει στον τίτλο του issue που έχετε αναλάβει.
101+
- Ανοίξτε ένα **Issue**
77102

78-
2. Επιβεβαιώστε ότι είστε στο 3.12 branch (πολύ σημαντικό βήμα για να αποφύγετε να ξεκινήσετε ένα branch απο παλαιότερη έκδοση):
103+
![new_issue](/public/assets/new-issue.png)
104+
105+
- Γράψτε στην περιγραφή τις παρατηρήσεις σας.
106+
- Μέσα από τα σχόλια του **Issue** θα συζητηθεί η παρατήρηση και το σχόλιο σας.
107+
- Αν από τη συζήτηση προκύψει ότι απαιτείται κάποια αλλάγη, είναι αρρεστό να την αναλάβετε εσείς. Κατ' αυτόν τον τρόπο θα κλείσετε το **Issue** σας με ένα δικό σας PR.
108+
109+
<h2 id="start-translation">Λερώστε τα χέρια σας! Μεταφράστε!</h2>
110+
111+
Εφόσον σας έχει ανατεθεί ένα αρχείο προς μετάφραση, ήρθε η ώρα να λερώσετε τα χέρια σας και να Ξεκινήσετε!
112+
113+
Τα αρχεία που πρέπει να μεταφρστούν είναι αυτά με την κατάληξη `.po`.
114+
115+
Τα εργαλεία που προτείνουμε για να χρησιμοποιήσετε είναι το [VScode](https://code.visualstudio.com/) ή το [PoEdit](https://poedit.net/). Για το [VScode](https://code.visualstudio.com/) μια χρήσιμη επέκταση είναι [`gettext` extension](https://marketplace.visualstudio.com/items?itemName=mrorz.language-gettext). Αντίθετα το [PoEdit](https://poedit.net/) χρησιμοποιεί ένα καλύτερο περιβάλλον διεπαφής και δεν απατείται να ασχοληθεί ο χρήστης με τη δομή του αρχείου.
116+
117+
2. Επιβεβαιώστε ότι είστε στο 3.12 branch (πολύ σημαντικό βήμα για να αποφύγετε να ξεκινήσετε ένα branch από παλαιότερη έκδοση):
79118

80119
```bash
81120
git checkout 3.12
@@ -85,51 +124,77 @@ git checkout 3.12
85124

86125
```bash
87126
git checkout -b translate-library-ast
127+
88128
ή
129+
89130
git checkout -b library-set
131+
90132
ή
133+
91134
git checkout -b ft/library-set
92135
```
93136

94-
4. Αφού έχετε διαλέξει το αρχείο σας, ξεκινήστε την μετάφραση στο IDE σας. Προτείνουμε το [poedit](https://poedit.net/) ή το [vscode](https://code.visualstudio.com/).
137+
4. Αφού έχετε διαλέξει το αρχείο σας, ξεκινήστε την μετάφραση στο IDE της επιλογής σας. Επίσης μπορείτε να χρησιμοποιείσετε εργαλεία για την σωστή μετάφραση προτάσεων, φράσεων ή λέξεων.
95138

96-
5. Εάν χρησιμοποιείτε το `poedit` είναι πιθανό πως το αρχείο σας θα έχει σωστό structure, αλλά για παν ενδεχόμενο μπορείτε να το επιβεβαιώσετε με το `powrap`. Για να το εγκαταστείσετε:
139+
5. Εφόσον έχετε ολοκληρώσει τη μετάφρασή σας είναι απαραίτητο να χρησιμοποιήσετε τις εντολές που αναφέρονται παρακάτω προκειμένου να γίνει μορφοποίηση του αρχείου για να έχει μια σωστή δομή καθώς και να γίνει ορθογραφικός έλεγχος.
97140

98-
```bash
99-
powrap <φακελος>/<ονομα_του_αρχειου>.po
100-
```
141+
1. `powrap`: έλεγχος και μορφοποίηση της δομής του αρχείου. Μπορείτε να χρησιμοποιήσετε το ακόλουθο script.
101142

102-
Εάν είστε χρήστης των windows μπορείτε να δείτε περισσότερες πληροφορίες [εδώ](https://python-docs-es.readthedocs.io/es/3.12/faq.html#powrap-windows).
143+
```bash
144+
powrap <φακελος>/<ονομα_του_αρχειου>.po
145+
```
103146

104-
6. **Έλεγχος ορθογραφίας**: Για να ελέγξετε την ορθοργραφία της μετάφρασης σας μπορείτε να χρησιμοποιείσετε το [pospell](https://github.com/AFPy/pospell) για να επιβεβαιώσετε ότι όλες οι λέξεις είναι γνωστές ή ανήκουν σε κάποιο από τα dictionaries. Μπορείτε επίσης να χρησιμοποιήσετε το παρακάτω script:
147+
Εάν είστε χρήστης των windows μπορείτε να δείτε περισσότερες πληροφορίες [εδώ](https://python-docs-es.readthedocs.io/es/3.12/faq.html#powrap-windows).
105148

106-
```bash
107-
python scripts/check_spelling.py <dir>/<file>.po
108-
```
149+
2. `popspell`: ορθογραφικός έλεγχος του αρχείου [pospell](https://github.com/AFPy/pospell). Μπορείτε να χρησιμοποιήσετε το ακόλουθο script.
150+
151+
```bash
152+
python scripts/check_spelling.py <dir>/<file>.po
153+
```
154+
155+
Εάν κάποια από τις λέξεις δεν είναι αναγνωρισμένη από το script προσθέστε την στο [dictionary](/dictionaries/main.txt) και επαναλάβετε.
156+
157+
3. `pre-commit`: ετοιμάζει και κάνει τις απαραίτητες διαδικασίες προκειμένου το αρχείο να περάσει επιτυχώς τους ελέγχους για την προσάρτισή του. Μπορείτε να χρησιμοποιήσετε το ακόλουθο script.
158+
159+
```bash
160+
pre-commit run --all-files
161+
```
109162

110-
Εάν κάποια από τις λέξεις δεν είναι αναγνωρισμένη από το script προσθέστε την στο [dictionary](/dictionaries/main.txt) και επαναλάβετε.
163+
Πιο αναλυτικά το παραπάνω script κάνει:
111164

112-
7. Μετά από την ολοκλήρωση της μετάφρασης μην ξεχάσετε να βάλετε τα στοιχεία σας στο:
165+
- τη διαδικασία του `powrap`
166+
- ορθογραφικό έλεγχο
167+
- μορφοποίηση του λεξικού (Αλφαβητική ταξινόμηση και αφαίρεση διπλότυπων)
168+
169+
6. Μετά από την ολοκλήρωση της μετάφρασης μην ξεχάσετε να βάλετε τα στοιχεία σας στο:
113170

114171
![metadata](/public/assets/metadata-po.png)
115172

116173
Στο **Language-Team** metadata γράφετε: `"Language-Team: PyGreece <[email protected]>\n"`
117174

118-
8. Όταν ολοκληρώσετε την μετάφραση σας, πρέπει να αποθηκεύσετε τις αλλαγές σας και να κάνετε push στο GitHub (Μην ξεχάσετε να προσθέσετε το όνομά σας στο αρχείο `TRANSLATORS`). Για παράδειγμα εάν εργαζόσασταν στο αρχείο `library/ast.po` τα βήματα θα ήταν:
175+
7. Όταν ολοκληρώσετε την μετάφραση σας, πρέπει να αποθηκεύσετε τις αλλαγές σας και να κάνετε push στο GitHub (Μην ξεχάσετε να προσθέσετε το όνομά σας στο αρχείο `TRANSLATORS`). Για παράδειγμα εάν εργαζόσασταν στο αρχείο `library/ast.po` τα βήματα θα ήταν:
119176

120177
```bash
121178
git add library/ast.po
122179
git commit -m 'Translate file library/ast.po'
123180
git push origin translate-library-ast
124181
```
125182

126-
8. Έπειτα μπορείτε να ανοίξετε ένα Pull Request προκειμένου να εξεταστεί/ελεγχθεί η συνεισφορά σας, να γίνουν κάποια σχόλια και εν τέλη να προσαρτηθεί στο βασικό repository:
183+
8. Έπειτα μπορείτε να ανοίξετε ένα Pull Request προκειμένου να εξεταστεί/ελεγχθεί η συνεισφορά σας, να γίνουν κάποια σχόλια και εν τέλη να προσαρτηθεί στο βασικό repository. Εφόσον έχετε κάνει push το branch σας θα δείτε κάτι όπως παρακάτω:
127184

128-
```
129-
Closes #<αριθμός issue>
130-
```
185+
![pr](/public/assets/pr.png)
186+
187+
Πατώντας το κουμπί θα μεταβείτε στην οθόνη για να βάλετε τις πληροφορίες του συγκεκριμένου _Pull Request_, και κάνοντας click στο κουμπί `Create pull request` θα δημιουργηθεί το PR.
188+
189+
![pr_descrtiption](/public/assets/pr-descrtiption.png)
190+
191+
Μπράβο σας! Ανεβάσετε το πρώτο σας PR. Τώρα απλώς περιμένετε να το αξιολογήσουν οι διαχειριστές, και έχετε το νου σας, μπορεί να σας ζητήσουν κάποιες αλλαγές.
192+
193+
Περιμένετε να σας κάνουν αποδοχή το PR σας.
194+
195+
### 🎉🎉ΤΕΛΟΣ🎉🎉
131196

132-
Έτσι θα κλείσει και το issue μόλις γίνει merge το PR.
197+
Συγχαρητήρια, συνεισφέρατε στο έργο και πλέον είστε μέλος του μεγάλου εγχειρήματος της μετάφρασης.
133198

134199
## Γενικές Οδηγίες
135200

0 commit comments

Comments
 (0)