Repository files navigation

NOTE REGARDING THE LICENSE FOR TRANSLATIONS: Python's documentation ismaintained using a global network of volunteers. By posting thisproject on Transifex, Github, and other public places, and invitingyou to participate, we are proposing an agreement that you willprovide your improvements to Python's documentation or the translationof Python's documentation for the PSF's use under the CC0 license(available athttps://creativecommons.org/publicdomain/zero/1.0/legalcode). Inreturn, you may publicly claim credit for the portion of thetranslation you contributed and if your translation is accepted by thePSF, you may (but are not required to) submit a patch including anappropriate annotation in the Misc/ACKS or TRANSLATORS file. Althoughnothing in this Documentation Contribution Agreement obligates the PSFto incorporate your textual contribution, your participation in thePython community is welcomed and appreciated.

You signify acceptance of this agreement by submitting your work tothe PSF for inclusion in the documentation.

You can contribute using:

• Github
• Or just by openingan issue on github

We will use Weblate in future. A few translators are online at #python-doc channel in libera.chat IRC server.

Prerequisites:

• Agithub account.
• gitinstalled (for windows, seehttps://gitforwindows.org/).
• A.po file editor (Usepoeditif you don't already have one).

Let's start:

You'll need to fork thepython-docs-bn-in clicking itsForkbutton. This creates a copy of the whole project on your githubaccount: a place where you have the rights to do modifications.

Step by step:

# Git clone your github fork using ssh (replace JulienPalard):git clone git@github.com:JulienPalard/python-docs-bn-in.git# Go to the cloned directory:cd python-docs-bn-in/# Add the upstream (the public repository) using HTTPS (won't ask for password):git remote add upstream https://github.com/python/python-docs-bn-in.git

All the translations must be made on the latest release.We never translate on an oldest version, by example, the latest Python releaseis Python 3.14, we don't want to translate directly on the Python 3.5 release.If needed translations would be backported on the oldest versions by thedocumentation team.

Now you're ready to start a work session, each time you'll start a new task, start here:

# To work, we'll need a branch, based on an up-to-date (freshly fetched)# upstream/3.14 branch, let's say we'll work on glossary so we name# the branch "glossary":git fetch upstreamgit checkout -b glossary upstream/3.14# You can now work on the file, typically using poedit,poedit directory/file.po# When everything is clear (syntax errors from Sphinx, html rendering,# semantics, typography),# you can commit your work with a nice explicit message:git commit -a -m"Working on glossary."# Then push your modifications to your github clone,# as they are ephemeral branches, let's not configure git to track them all,# "origin HEAD" is a "special" syntax to say "Push on origin,# on a branch with the same name as the local one",# it's nice as it's exactly what we want:git push origin HEAD# The previous command will print you a link to open a PR on github.# If you missed it, just go to# https://github.com/python/python-docs-bn-in/ and a nice "Compare & pull request"# button should appear after a few seconds telling you can ask for a pull request.# Now someone is reviewing your modifications, and you'll want to fix their# findings, get back to your branch# (in case you started something else on another branch):git checkout glossary# Fix the issues, then commit again:git commit -a -m"glossary: small fixes."git push origin HEAD

You may have noted that this looks like a triangle, with a missing segment:

• You're fetching from upstream (public common repo on github)
• You're pushing to origin (your clone on github)

So yes it's the work of someone to add the last segment, from yourorigin to the public upstream, to "close the loop", that's the role ofthe people who merges pull requests after proofreading them.

You may also have noted you never ever commit on a version branch(3.6,3.7, ...), only pull from them, consider them read-onlyyou'll avoid problems.

You can start with easy tasks like reviewing fuzzy entries to helpkeeping the documentation up to date (find them usingmake fuzzy).

You can also proofread already translated entries, and finallytranslate untranslated ones (find them usingmake todo)..

• Do not translate content of:ref:... and:term:...
• Put english words, if you have to use them, initalics (surroundedby stars).
• If you translate a link title, please translate the link too(typically if it's Wikipedia and the article has a translation). Ifno translation of the target exists, do not translate thetitle.

For consistency in our translations, here are some propositions andreminders for frequent terms you'll have to translate, don't hesitateto open an issue if you disagree.

To easily find how a term is already translated in our documentation,you may usefind_in_po.py.

Git diffs are often crowded with useless line number changes, like:

-#: ../Doc/library/signal.rst:406+#: ../Doc/library/signal.rst:408

To tell git they are not usefull information, you can do the followingafter ensuring~/.local/bin/ is in yourPATH.

cat<<EOF > ~/.local/bin/podiff#!/bin/shgrep -v '^#:' "\$1"EOFchmod a+x~/.local/bin/podiffgit config diff.podiff.textconv podiff

All those snippets are to run from the root of apython-docs-bn-inclone, and some expect to find an up-to-date CPython clone near to it,like:

~/├── python-docs-bn-in/└── cpython/

To clone CPython you may use:

git clone --depth 1 --no-single-branch https://github.com/python/cpython.git

This avoids to download the whole history (not usefull to builddocumentation) but still fetches all branches.

make merge

make fuzzy

make

You'll need thetransifex-client andpowrapfrom Pypi.

You'll need to configuretx viatx init if not already done.

pomerge --from-files**/*.potx pull -fpomerge --to-files**/*.popomerge --from-files**/*.pogit checkout --.pomerge --to-files**/*.popowrap --modifiedgit commit -m"tx pull"tx push -t -f