NOTE REGARDING THE LICENSE FOR TRANSLATIONS: Python's documentation is maintained using a global network of volunteers. By posting this project on Transifex, Github, and other public places, and inviting you to participate, we are proposing an agreement that you will provide your improvements to Python's documentation or the translation of Python's documentation for the PSF's use under the CC0 license (available at https://creativecommons.org/publicdomain/zero/1.0/legalcode). In return, you may publicly claim credit for the portion of the translation you contributed and if your translation is accepted by the PSF, you may (but are not required to) submit a patch including an appropriate annotation in the Misc/ACKS or TRANSLATORS file. Although nothing in this Documentation Contribution Agreement obligates the PSF to incorporate your textual contribution, your participation in the Python community is welcomed and appreciated.
You signify acceptance of this agreement by submitting your work to the PSF for inclusion in the documentation.
You can contribute using:
- Github
- Or just by opening an issue on github
Prerequisites:
- A github account.
gitinstalled (for windows, see https://gitforwindows.org/).- A
.pofile editor (Use poedit if you don't already have one).
Let's start:
You'll need to fork the python-docs-es clicking its Fork
button. This creates a copy of the whole project on your github
account: a place where you have the rights to do modifications.
Step by step:
# Git clone your github fork using ssh (replace raulcd):
git clone git@github.com:raulcd/python-docs-es.git
# Go to the cloned directory:
cd python-docs-es/
# Add the upstream (the public repository) using HTTPS (won't ask for password):
git remote add upstream https://github.com/raulcd/python-docs-es.gitAll the translations must be made on the latest release. We never translate on an oldest version, by example, the latest python release is python 3.7, we don't want to translate directly on the python 3.5 release. If needed translations would be backported on the oldest versions by the documentation team <https://www.python.org/dev/peps/pep-8015/#documentation-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.7 branch, let's say we'll work on glossary so we name
# the branch "glossary":
git fetch upstream
git checkout -b glossary upstream/3.7
# 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/raulcd/python-docs-es/ 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
#
9B1C
Fix the issues, then commit again:
git commit -a -m "glossary: small fixes."
git push origin HEADYou 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 your origin to the public upstream, to "close the loop", that's the role of the 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-only
you'll avoid problems.
You can start with easy tasks like reviewing fuzzy entries to help
keeping the documentation up to date (find them using make fuzzy).
You can also proofread already translated entries, and finally
translate untranslated ones (find them using make todo)..
- Do not translate content of
:ref:...and:term:... - Put english words, if you have to use them, in italics (surrounded by stars).
- If you translate a link title, please translate the link too (typically if it's Wikipedia and the article has a translation). If no translation of the target exists, do not translate the title.
For consistency in our translations, here are some propositions and reminders for frequent terms you'll have to translate, don't hesitate to open an issue if you disagree.
To easily find how a term is already translated in our documentation, you may use find_in_po.py.
| Term | Proposed Translation |
|---|---|
| -like | |
| abstract data type | |
| argument | |
| backslash | |
| bound | |
| bug | |
| built-in | |
| call stack | |
| debugging | |
| deep copy | |
| double quote | |
| e.g. | |
| garbage collector | |
| identifier | |
| immutable | |
| installer | |
| interpreter | |
| library | |
| list comprehension | |
| little-endian, big-endian | |
| mutable | |
| namespace | |
| parameter | |
| prompt | |
| raise | |
| regular expression | |
| return | |
| simple quote | |
| socket | |
| statement | |
| subprocess | |
| thread | |
| underscore | |
| expression |
Git diffs are often crowded with useless line number changes, like:
-#: ../Doc/library/signal.rst:406
+#: ../Doc/library/signal.rst:408To tell git they are not usefull information, you can do the following
after ensuring ~/.local/bin/ is in your PATH.
cat <<EOF > ~/.local/bin/podiff
#!/bin/sh
grep -v '^#:' "\$1"
EOF
chmod a+x ~/.local/bin/podiff
git config diff.podiff.textconv podiffAll those snippets are to run from the root of a python-docs-es
clone, and some expect to find an up-to-date CPython clone near to it,
like:
~/
├── python-docs-es/
└── cpython/To clone CPython you may use:
git clone --depth 1 --no-single-branch https://github.com/python/cpython.gitThis avoids to download the whole history (not usefull to build documentation) but still fetches all branches.
make mergemake fuzzymakeYou'll need the transifex-client and powrap
from Pypi.
You'll need to configure tx via tx init if not already done.
pomerge --from-files **/*.po
tx pull -f
pomerge --to-files **/*.po
pomerge --from-files **/*.po
git checkout -- .
pomerge --to-files **/*.po
powrap --modified
git commit -m "tx pull"
tx push -t -f