You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit eba7ecd
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+71-13Lines changed: 71 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,6 +32,28 @@ Whether you are fixing a typo, translating a new document, reviewing terminology
32
32
33
33
The Punjabi (`pa`) translation project is actively maintained and follows the official Python Documentation Translation workflow.
34
34
35
+
## Project Team
36
+
37
+
The Punjabi (`pa`) translation project is maintained collaboratively by a team of coordinators and contributors through the official Python Documentation Translation project on Transifex.
38
+
39
+
### Coordinators
40
+
41
+
The project is currently coordinated by:
42
+
43
+
- Bhuvansh Kataria (@BHUVANSH855)
44
+
- Mohit Yadav (@mohityadav8)
45
+
- Yashraj Jangra (@jangrayash1505)
46
+
47
+
The coordinators are responsible for:
48
+
49
+
- Managing the translation project.
50
+
- Maintaining translation quality.
51
+
- Coordinating contributors and reviewers.
52
+
- Ensuring consistency across translated documentation.
53
+
- Overseeing validation and synchronization workflows.
54
+
55
+
---
56
+
35
57
### Current Highlights
36
58
37
59
- ✅ Officially listed in the Python Developer Guide Translation Coordinators (PR #1843)
@@ -64,21 +86,21 @@ The Punjabi (`pa`) translation project is actively maintained and follows the of
64
86
| Metric | Value |
65
87
|--------|------:|
66
88
| Verified Translated Strings |**7,668**|
67
-
| Tutorial Files | 17 |
68
-
| Using Python Files | 9 |
69
-
|Completed Core Library Files | 5 |
70
-
|Completed HOWTO Files | 2 |
71
-
| Root Translation Files | 2 |
89
+
| Tutorial Files Completed | 17 |
90
+
| Using Python Files Completed | 9 |
91
+
| Core Library Files Completed| 5 |
92
+
| HOWTO Files Completed| 2 |
93
+
| Root Translation Files Completed | 2 |
72
94
73
95
### Current Priorities
74
96
75
97
Current development focuses on:
76
98
77
-
-Expanding translations across additional Standard Library modules.
78
-
-Continuing HOWTO, FAQ, Reference, C API, and What's New documentation.
79
-
- Maintaining terminology consistency through community review.
99
+
-Reviewing existing translations for terminology consistency and technical accuracy.
100
+
-Expanding translations across additional Standard Library, HOWTO, FAQ, Reference, C API, and What's New documentation.
101
+
- Maintaining consistency with `GLOSSARY.md` and `STYLE_GUIDE.md`.
80
102
- Keeping translations synchronized with upstream CPython documentation.
81
-
-Preparing the project for future integration with Python's documentation build infrastructure.
103
+
-Growing the Punjabi translation community and onboarding new contributors and reviewers.
82
104
83
105
---
84
106
@@ -146,11 +168,11 @@ The Punjabi (`pa`) translation project follows the standard Python Documentation
146
168
```text
147
169
Translate in Transifex
148
170
↓
149
-
Community Review
171
+
Follow GLOSSARY.md
150
172
↓
151
-
Terminology Verification (GLOSSARY.md)
173
+
Follow STYLE_GUIDE.md
152
174
↓
153
-
Translation Style Review (STYLE_GUIDE.md)
175
+
Peer Review
154
176
↓
155
177
Automated Synchronization to GitHub
156
178
↓
@@ -176,6 +198,7 @@ Contributors can help in several ways:
176
198
- Translate untranslated documentation.
177
199
- Review existing translations.
178
200
- Improve terminology consistency.
201
+
- Validate translations locally.
179
202
- Fix formatting or reStructuredText issues.
180
203
- Correct validation errors.
181
204
- Improve documentation quality.
@@ -230,6 +253,10 @@ After creating a new `.po` file:
230
253
231
254
Every completed translation should pass all validation checks before submission.
232
255
256
+
> **Validation and translation review are separate processes.**
257
+
>
258
+
> Automated validation verifies translation syntax, markup preservation, and documentation build correctness. Human review focuses on terminology consistency, language quality, technical accuracy, and adherence to the project's glossary and style guide.
259
+
233
260
## Validation Pipeline
234
261
235
262
```text
@@ -298,6 +325,23 @@ All commands should complete successfully before submitting a contribution.
298
325
299
326
---
300
327
328
+
## Review Guidelines
329
+
330
+
Review is a collaborative process intended to improve translation quality rather than simply identify errors. Contributors and reviewers are encouraged to discuss terminology, phrasing, and technical accuracy to achieve consistent, high-quality translations.
331
+
332
+
Automated validation confirms that a translation is technically valid, but it does not verify translation quality.
333
+
334
+
During review, contributors and reviewers should check:
335
+
336
+
- Technical accuracy.
337
+
- Consistency with `GLOSSARY.md`.
338
+
- Compliance with `STYLE_GUIDE.md`.
339
+
- Natural Punjabi wording.
340
+
- Preservation of reStructuredText and Sphinx markup.
341
+
- Correct handling of cross-references, directives, and code examples.
342
+
343
+
---
344
+
301
345
# Translation Rules
302
346
303
347
Maintaining consistency is one of the most important goals of this project.
@@ -433,6 +477,20 @@ Avoid literal word-for-word translations when a more natural Punjabi expression
433
477
434
478
---
435
479
480
+
## Reviewer Responsibilities
481
+
482
+
Reviewers help ensure that translations are technically accurate, linguistically natural, and consistent across the project.
483
+
484
+
A reviewer should:
485
+
486
+
- Verify terminology against `GLOSSARY.md`.
487
+
- Check compliance with `STYLE_GUIDE.md`.
488
+
- Preserve original meaning and technical intent.
489
+
- Ensure all Sphinx and reStructuredText markup remains unchanged.
490
+
- Report inconsistencies or suggest improvements through GitHub or Transifex.
491
+
492
+
---
493
+
436
494
# Quality Checklist
437
495
438
496
Before submitting your contribution, ensure that:
@@ -512,7 +570,7 @@ Contributors should:
512
570
- Preserve all reStructuredText roles, directives, hyperlinks, and formatting.
513
571
- Keep code examples identical to the original documentation.
514
572
- Preserve indentation and whitespace where required.
515
-
- Review completed translations before submission.
573
+
- Review completed translations for technical accuracy, terminology consistency, and natural Punjabi wording before submission.
516
574
- Follow translation patterns established in completed project files whenever appropriate.
517
575
518
576
When uncertain about a translation, prioritize consistency with existing project terminology rather than introducing new wording.
0 commit comments