Skip to content

Commit c8f2307

Browse files
committed
Add Punjabi README with an English version
1 parent bf3d780 commit c8f2307

2 files changed

Lines changed: 69 additions & 324 deletions

File tree

‎README.en.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Python Documentation Translation — Punjabi (ਪੰਜਾਬੀ)
2+
3+
[ਪੰਜਾਬੀ](README.md)
4+
5+
Punjabi (Gurmukhi, `pa`) translation of the [Python documentation](https://docs.python.org/).
6+
7+
- **Read it:** <https://docs.python.org/pa/>
8+
- **Progress:** <https://translations.python.org/> (updated automatically)
9+
- **Translate and review:** [Transifex](https://explore.transifex.com/python-doc/python-newest/), language Punjabi (`pa`)
10+
- **Contribute:** see [CONTRIBUTING.md](CONTRIBUTING.md)
11+
12+
## How do we translate?
13+
14+
1. Open the [Python Documentation project](https://explore.transifex.com/python-doc/python-newest/) on Transifex.
15+
2. Click "Join this project". Create a Transifex account if you don't have one.
16+
3. Select Punjabi (`pa`) on the project page.
17+
4. After a coordinator approves your request, pick a resource and follow [Transifex_Setup.md](Transifex_Setup.md).
18+
5. A reviewer approves your translations, and the daily sync brings them to this repository. You don't need to open a pull request for translations.
19+
20+
## How does it work?
21+
22+
Translations are written and reviewed in Transifex. A GitHub Actions workflow pulls the **reviewed** translations into this repository every day, into the `3.13`, `3.14` and `3.15` branches. Strings that are translated but not yet reviewed stay in Transifex until they are reviewed, so they are not in the repository yet.
23+
24+
Every push and pull request runs `msgfmt --check` on all `.po` files. The Python documentation build uses this repository to publish the Punjabi site.
25+
26+
## Guides
27+
28+
| File | Contents |
29+
|------|----------|
30+
| [CONTRIBUTING.md](CONTRIBUTING.md) | How to contribute, validate and submit changes |
31+
| [Transifex_Setup.md](Transifex_Setup.md) | First steps in Transifex |
32+
| [STYLE_GUIDE.md](STYLE_GUIDE.md) | Translation style and conventions |
33+
| [RULES.md](RULES.md) | Detailed rules for markup, placeholders and `.po` files |
34+
| [GLOSSARY.md](GLOSSARY.md) | Preferred Punjabi terminology |
35+
36+
## Coordinators
37+
38+
[@BHUVANSH855](https://github.com/BHUVANSH855), [@mohityadav8](https://github.com/mohityadav8) and [@Yashraj-Jangra](https://github.com/Yashraj-Jangra).
39+
40+
## License
41+
42+
Translations are contributed under the [CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/) license.

0 commit comments

Comments
 (0)