Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit4153267

Browse files
authored
Add CONTRIBUTING.md and doc pages (#10)
1 parentb5de29a commit4153267

File tree

4 files changed

+223
-0
lines changed

4 files changed

+223
-0
lines changed

‎CONTRIBUTING.md

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
#Οδηγός συνεισφοράς στο πρότζεκτ Python-Doc-Gr της κοινότητας PyGreece
2+
3+
Eυχαριστούμε πολύ για το ενδιαφέρον σας να συμμετέχετε στη μετάφραση των επίσημων εγγράφων της Python στα Ελληνικά!
4+
5+
Το συγκεκριμένο πρότζεκτ έχει ξεκινήσει από το PyGreece, μια online κοινότητα εθελοντών της Python. Στο συγκεκριμένο repository θα βρείτε την ομάδα εργασίας που είναι υπεύθυνη για το πρότζεκτ. Όλο το περιεχόμενο της μετάφρασης συντηρείται από εθελοντές που συνεισφέρουν το χρόνο και την εργασία τους στην κοινότητα της Python.
6+
7+
Σε περίπτωση που έχετε οποιαδήποτε απορία για το πρότζεκτ, μπορείτε να μας βρείτε με τους εξής τρόπους:
8+
9+
- Μπορείτε να μπείτε στον discord server του PyGreece (πρόσκληση εδώ:https://discord.gg/evcNPRVCMB)
10+
11+
- Μπορείτε να μας βρείτε στο linkedin[εδώ](https://www.linkedin.com/company/pygreece)
12+
13+
Πριν ξεκινήσετε με την πρώτη σας μετάφραση θα θέλαμε να μοιραστούμε[κάποιες γενικές οδηγίες](#γενικές-οδηγίες).
14+
15+
##Βήμα 1: Github Setup
16+
17+
Πρέπει να κάνετε αυτό το βήμα μόνο μία φορά. Με το συγκεκριμένο fork μπορείτε να κάνετε όσα PR θέλετε.
18+
19+
1. Για να υποβάλετε μια μετάφραση, πρέπει να έχετε ένα fork του repository , κάνοντας κλικ στο κουμπί με την κόκκινη γραμμή από κάτω (για περισσότερες πληροφορίες δείτε[εδώ](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)):
20+
21+
![fork](https://github.com/pygreece/python-docs-gr/blob/3.12/public/assets/fork_image.jpg?raw=true)
22+
23+
2. Κάντε clone το repository που μόλις δημιουργήσατε:
24+
25+
```bash
26+
git clone git@github.com:<το username σας>/python-docs-gr.git
27+
```
28+
29+
3. Μεταβείτε στον φάκελο που δημιουργήθηκε:
30+
31+
```bash
32+
cd python-docs-gr/
33+
```
34+
35+
4. Προσθέστε το επίσημο repository ως upstream:
36+
37+
```bash
38+
git remote add upstream git@github.com:pygreece/python-docs-gr.git
39+
```
40+
41+
5.[Προαιρετικό βήμα] Δημιουργείστε ένα virtual environment και κάντε activate:
42+
43+
```bash
44+
python -m venv env
45+
source env/bin/activate# macOS or Linux
46+
env\Scripts\activate.bat# Windows
47+
```
48+
49+
6.[Προαιρετικό βήμα] Εγκαταστείστε τα requirements:
50+
51+
```bash
52+
pip install -r requirements.txt
53+
```
54+
55+
##Βήμα 2: Ποια αρχεία πρέπει να μεταφραστούν;
56+
57+
Έχουμε[μια λίστα με issues στο GitHub](https://github.com/pygreece/python-docs-gr/issues?q=is%3Aissue+is%3Aopen+label%3Atranslation) όπου συντονίζουμε τη δουλειά που γίνεται ώστε να μην μεταφραστεί το ίδιο έγγραφο δύο φορές. Η διαδικασία μετάφρασης ενός αρχείου είναι η εξής:
58+
59+
- Επιλέξτε οποιοδήποτε από τα issues που δεν έχουν ανατεθεί σε κάποιο άλλο άτομο.
60+
61+
- Αφήστε ένα σχόλιο για στο issue λέγοντας ότι θέλετε να το δουλέψετε.
62+
63+
- Περιμένετε έναν διαχειριστή να σας αναθέσει το issue.
64+
65+
- Ξεκινήστε τη μετάφραση!
66+
67+
##Βήμα 3: Ξεκινήστε τη μετάφραση!
68+
69+
1. Διαλέξτε το αρχείο που θέλετε να μεταφράσετε. Το αρχείο θα υπάρχει στον τίτλο του issue που έχετε αναλάβει.
70+
71+
2. Επιβεβαιώστε ότι είστε στο 3.12 branch (πολύ σημαντικό βήμα για να αποφύγετε να ξεκινήσετε ένα branch απο παλαιότερη έκδοση):
72+
73+
```bash
74+
git checkout 3.12
75+
```
76+
77+
3. Δημιουργείστε ένα branch βασισμένο στο αρχείο που θα δουλέψετε. Για παράδειγμα, εάν δουλέυετε στο αρχείο library/ast.po το όνομα του branch θα μπορούσε να είναι:
78+
79+
```bash
80+
git checkout -b translate-library-ast
81+
```
82+
83+
4. Αφού έχετε διαλέξει το αρχείο σας, ξεκινήστε την μετάφραση στο IDE σας. Προτείνουμε το[poedit](https://poedit.net/) ή το[vscode](https://code.visualstudio.com/).
84+
85+
5. Εάν χρησιμοποιείτε το`poedit` είναι πιθανό πως το αρχείο σας θα έχει σωστό structure, αλλά για παν ενδεχόμενο μπορείτε να το επιβεβαιώσετε με το`powrap`. Για να το εγκαταστείσετε:
86+
87+
```bash
88+
powrap<φακελος>/<ονομα_του_αρχειου>.po
89+
```
90+
91+
Εάν είστε χρήστης των windows μπορείτε να δείτε περισσότερες πληροφορίες[εδώ](https://python-docs-es.readthedocs.io/es/3.12/faq.html#powrap-windows).
92+
93+
6.**Έλεγχος ορθογραφίας**: Για να ελέγξετε την ορθοργραφία της μετάφρασης σας μπορείτε να χρησιμοποιείσετε το[pospell](https://github.com/AFPy/pospell) για να επιβεβαιώσετε ότι όλες οι λέξεις είναι γνωστές ή ανήκουν σε κάποιο από τα dictionaries. Μπορείτε επίσης να χρησιμοποιήσετε το παρακάτω script:
94+
95+
```bash
96+
python scripts/check_spelling.py<dir>/<file>.po
97+
```
98+
99+
Εάν κάποια από τις λέξεις δεν είναι αναγνωρισμένη από το script προσθέστε την στο dictionary και επαναλάβετε. Για παράδειγμα, εάν το αρχείο που δουλεύετε είναι το`library/ast.po` το αντίστοιχο dictionary είναι το`dictionaries/library_ast.txt`. Εάν το αρχείο που ψάχνετε δεν υπάρχει στο φάκελο dictionaries δημιουργείστε το.
100+
101+
7. Όταν ολοκληρώσετε την μετάφραση σας, πρέπει να αποθηκεύσετε τις αλλαγές σας και να κάνετε push στο GitHub (Μην ξεχάσετε να προσθέσετε το όνομά σας στο αρχείο`TRANSLATORS`). Για παράδειγμα εάν εργαζόσασταν στη στο αρχείο`library/ast.po` τα βήματα θα ήταν:
102+
103+
```bash
104+
git add library/ast.po
105+
git commit -m'Translate file library/ast.po'
106+
git push origin translate-library-ast
107+
```
108+
109+
8. Στην περιγραφή του Pull Request μπορείτε να γράψετε:
110+
111+
```
112+
Closes #<αριθμός issue>
113+
```
114+
115+
Έτσι θα κλείσει και το issue μόλις γίνει merge το PR.
116+
117+
##Γενικές Οδηγίες
118+
119+
- Σε πολλές περιπτώσεις το καλύτερο κριτήριο είναι να σκεφτούμε το λεξιλόγιο που χρησιμοποιούμε όταν εξηγούμε σε άλλο άτομο ή στη δουλειά. Σε πολλές περιπτώσεις, η αγγλική είναι πολύ καλύτερη αν θελετε πχ. να πείτε "git join".
120+
121+
- Θα έχετε πάντα διαθέσιμο ενα preview αυτού που προτείνετε, καθώς και reviewers να σας βοηθήσουν.
122+
123+
- Η διαδικασιά του review ειναι επίσης πολύ σημαντική. Αν έχετε ελεύθερο χρόνο θα ήταν το ίδιο σημαντικό να συνεισφέρετε κάνοντας review σε ήδη ανοιχτά Pull Requests ([περισσότερες πληροφορίες εδώ](./public/docs/review.md)).
124+
125+
- Τα επίσημα έγγραφα της Python είναι άπειρα! Όποια εμπόδια βρείτε μπορείτε πάντα να επισημάνετε το κείμενο ως "ασαφές" ή να το αναθεωρήσετε στο μέλλον. Μην σπαταλάτε ώρες αναζητώντας την τέλεια λέξη.
126+
127+
- Δεν πρέπει να μεταφράσετε το περιεχόμενο των :ref:..., :term:..., :dfn:..., κ.λπ.
128+
129+
- Εάν πρέπει να χρησιμοποιήσετε αγγλικές λέξεις, θα πρέπει να τις βάλετε με πλάγιους χαρακτήρες (περιτριγυρισμένοι με αστερίσκους).
130+
131+
- Μπορείτε να διαβάσετε τις Συχνές Ερωτήσεις για να διαβάσετε για γνωστά ζητήματα.
132+
133+
- Εάν μεταφράσετε έναν τίτλο που είναι σύνδεσμος, μεταφράστε και τον σύνδεσμο (για παράδειγμα ένα άρθρο στη Wikipedia). Σε περίπτωση που δεν υπάρχει μετάφραση του άρθρου στη Wikipedia, αφήστε τον τίτλο αμετάφραστο.
134+
135+
- Εάν έχετε μια ερώτηση σχετικά με μια λέξη ή όρο, γράψτε την όπως σας φαίνεται καλύτερα και σημειώστε αυτήν την παράγραφο ως "Needs Work". Επίσης, γράψτε ένα σχόλιο εξηγώντας για ποιον όρο σε αυτήν την παράγραφο δεν ήσασταν σίγουροι.
136+
137+
- Συνιστούμε να ανοίξετε ένα Pull Request ακόμα κι αν είναι σε μορφή draft (επισημασμένο ως πρόχειρο) από τις πρώτες προσπάθειες της μετάφρασης του αρχείου σας. Με αυτόν τον τρόπο, μπορείτε να λάβετε σχόλια από την αρχή που μπορείτε να εφαρμόσετε στην υπόλοιπη μετάφραση.
138+
139+
- Τελευταίο αλλά όχι λιγότερο σημαντικό, διασκεδάστε και βασιστείτε στη βοήθεια όλων. Περιμένουμε τα μηνύματα σας στο discord, εδώ ή στο linkedin. Ευχαριστούμε!
140+
141+
- Για τους contributors που χρησιμοποιούν το vscode ως IDE ένα πολύ χρήσιμο add-on για τα`.po` αρχεία είναι το[`gettext` extension](https://marketplace.visualstudio.com/items?itemName=mrorz.language-gettext).

‎public/assets/fork_image.jpg

35.2 KB
Loading

‎public/docs/review.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
**Σημείωση: Βοηθείστε μας να μεταφράσουμε την επίσημη μετάφραση της Python στα Ελληνικά! Μπορείτε να βρείτε περισσότερες πληροφορίες για το πως μπορείτε να συνεισφέρετε[εδώ](./../../CONTRIBUTING.md).**
2+
3+
#Οδηγίες για το review των μεταφράσεων
4+
5+
Το review ενός Pull Request είναι μια πολύ σημαντική διαδικασία για την μετάφραση των εγγράφων της Python.
6+
7+
Για όσους δεν έχουν κάνει ποτέ review, αλλά έχετε κάνει μεταφράσεις για το πρότζεκτ, σας συνιστούμε να το δοκιμάσετε. Μέσω του review, θα μπείτε πολλές φορές στη θέση κάποιου άλλου και συχνά θα δείτε βελτίωση και των δικών σας μεταφράσεων/PR.
8+
9+
Ένας καλός οδηγός από το Github για τα reviews είναι[εδώ](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)
10+
11+
##Η ανθρώπινη πλευρά
12+
13+
Λαμβάνοντας υπόψη ότι είμαστε όλοι εθελοντές σε αυτό το έργο, είναι σημαντικό ο τρόπος που επικοινωνούμε να είναι σαφής, συνοπτικός και φιλικός. Να θυμάστε ότι στην άλλη πλευρά ενός PR υπάρχει ένα άτομο που έχει αφιερώσει χρόνο και προσπάθεια. Ο τρόπος που σχολιάζετε τη δουλειά του θα επηρεάσει τη στάση του απέναντι στο έργο και την επιθυμία του να συνεχίσει να συμμετέχει στην κοινότητά μας! Εδώ σας αφήνουμε μερικές συμβουλές ώστε το review σας να είναι εποικοδομητικό:
14+
15+
- Πάντα να αφήνετε ένα σχόλιο στο PR που αφήνει ένα γενικό συμπέρασμα του review σας για να καταστεί σαφές στους μεταφραστές τι χρειάζεται τροποποίηση και τι όχι. Να θυμάστε πάντα να ξεκινάτε αναγνωρίζοντας τις θετικές πτυχές της δουλειάς του άλλου και στη συνέχεια μπορείτε να προσθέσετε σχόλια/προτάσεις σχετικά με τη μετάφραση.
16+
17+
##Η πρακτική πλευρά
18+
19+
To review πρέπει να είναι ακριβές. Με αυτόν τον τρόπο, οι μεταφραστές θα μπορούν να αναθεωρούν τη δουλειά τους και να γνωρίζουν τι πρέπει να κάνουν για να τη βελτιώσουν. Μην ξεχνάτε ότι αυτή είναι μια τεχνική μετάφραση και ως εκ τούτου, ο στόχος είναι ότι, το άτομο που τη διαβάζει μπορεί να καταλάβει πώς να χρησιμοποιεί την Python. Αυτός είναι ο λόγος για τον οποίο, αν και είναι σημαντικό η σύνταξη να είναι σωστή, ο στόχος δεν είναι να γίνει μια εντατική ανασκόπηση της χρήσης των ελληνικών, εκτός εάν ο τρόπος με τον οποίο εκφράστηκε η ιδέα καθιστά αδύνατο για κάποιο άλλο άτομο να την κατανοήσει.
20+
21+
Για αυτό, το Github σάς προσφέρει επιλογές για να κάνετε review ένα PR (δείτε το κουμπί`Review Changes` στην επάνω δεξιά γωνία των αρχείων που έχουν τροποποιηθεί από τους μεταφραστές):
22+
23+
-`Comment`: Μπορείτε να αφήσετε ένα σχόλιο χωρίς απαραίτητα να εγκρίνετε το PR. Βεβαιωθείτε ότι το κάνετε με σαφήνεια, ώστε όποιος μετέφρασε να γνωρίζει ότι πρέπει να τροποποιήσει κάποια πράγματα πριν εγκριθεί το PR του.
24+
25+
-`Approve` : Αφήστε αυτήν την επιλογή μόνο για PR που δεν χρειάζονται καμία τροποποίηση ή έχουν μόνο μερικά ορθογραφικά λάθη ή τυπογραφικά λάθη ή κάποιο σφάλμα που δεν προκαλεί μεγάλη σύγκρουση στη μετάφραση και την ενσωμάτωσή της στο κύριο branch.
26+
27+
-`Request Changes`: Χρησιμοποιήστε αυτήν την επιλογή όταν η μετάφραση χρειάζεται πολλές τροποποιήσεις που επηρεάζουν την ενσωμάτωσή της στο κύριο branch. Σε αυτήν την περίπτωση, βεβαιωθείτε επίσης ότι το μήνυμά σας είναι σαφές και φιλικό για να συνοδεύει τον μεταφραστή στη διαδικασία τροποποίησης και έγκρισης του PR.

‎scripts/check_spelling.py

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
"""
2+
Script to check the spelling of one, many or all .po files based
3+
on the custom dictionaries under the 'dictionaries/' directory.
4+
"""
5+
6+
frompathlibimportPath
7+
importsys
8+
importtempfile
9+
10+
importpospell
11+
12+
13+
defcheck_spell(po_files=None):
14+
"""
15+
Check spell in the given list of po_files and log the spell errors details.
16+
17+
If no po_files are given, check spell in all files.
18+
19+
args:
20+
po_files: list of po_files paths.
21+
22+
returns:
23+
- int: spell errors count.
24+
25+
"""
26+
# Read custom dictionaries
27+
entries=set()
28+
forfilenameinPath("dictionaries").glob("*.txt"):
29+
withopen(filename,"r")asf:
30+
entries.update(
31+
stripped_line
32+
forstripped_linein (line.strip()forlineinf.readlines())
33+
ifstripped_line
34+
)
35+
36+
# Write merged dictionary file
37+
output_filename=tempfile.mktemp(suffix="_merged_dict.txt")
38+
withopen(output_filename,"w")asf:
39+
foreinentries:
40+
f.write(f"{e}\n")
41+
42+
# Run pospell either against all files or the file given on the command line
43+
ifnotpo_files:
44+
po_files=Path(".").glob("*/*.po")
45+
46+
detected_errors=pospell.spell_check(
47+
po_files,personal_dict=output_filename,language="el_EL"
48+
)
49+
returndetected_errors
50+
51+
52+
if__name__=="__main__":
53+
po_files=sys.argv[1:]
54+
errors=check_spell(po_files)
55+
sys.exit(0iferrors==0else-1)

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp