Melcore/python-docs-fr
1
0
Fork 0
forked from AFPy/python-docs-fr
Code Pull Requests Activity

More detail about contributing with github.

Browse Source
This commit is contained in:
Julien Palard 2018-06-30 12:24:23 +02:00
parent 0d8c24f9db
commit 5e1dfe7201
1 changed files with 31 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.rst
View File

@ -32,16 +32,31 @@ Contributing to the Translation
How to Contribute How to Contribute
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
You can either contribute on `transifex/python-doc/public You contribute using:
<https://www.transifex.com/python-doc/public/>`_, or by simply openning an
issue on this repository, or by editing the ``po`` files.
To modify those files you first have to fork this project and follow - github (preferred solution)
github instructions to clone it. - `transifex <https://www.transifex.com/python-doc/public/>`_
- Or just by opening `an issue on github <https://github.com/python/python-docs-fr/issues>`_
Next, to edit the files, you can use an editor of your choice, there's many:
- Highly recommended: `poedit <http://www.poedit.net/>`_ Contributing using Github
~~~~~~~~~~~~~~~~~~~~~~~~~
You'll first need a `github account <https://github.com/join>`_.
Then you'll need to fork the project by clicking the ``Fork`` button
on `python-docs-fr <https://github.com/python/python-docs-fr>`_. This
creates a copy of the whole project on your github account: a place
where you have the rights to do modifications.
To modify po files you'll need to synchronize the project files to
your computer by using ``git``: https://help.github.com/articles/set-up-git/.
Once the project ``git clone``ed, you'll be able to modify the files
containing the translations, those are ``.po`` files and can be
modified using various tools:
- `poedit <http://www.poedit.net/>`_ (recommended)
- gted - gted
- gtranslator - gtranslator
- lokalize - lokalize
@ -53,12 +68,13 @@ Next, to edit the files, you can use an editor of your choice, there's many:
Before commiting, you should use `grammalecte Before commiting, you should use `grammalecte
<https://www.dicollecte.org/>`_ to check for your translations. <https://www.dicollecte.org/>`_ to check for your translations.
Finally, once your contribution is done, do a ``pull request`` so we After commiting (this is just "naming the modification"), synchronize
can review and merge it. the file back to github using ``git push``.
Please write your issues and pull requests in english for consistency And now, from your github project, a buttun should appear "Create a
with the python github organization and because non-french people may pull requests", this is asking us, the main project, to pull your
receive github notifications about our activity. modifications. This step may take some time as we'll review your
modifications before accepting them, and we may ask for modifications.
What to translate What to translate
@ -86,8 +102,9 @@ Where to get help
The coordinator for this translation is `mdk <https://mdk.fr/>`_. The coordinator for this translation is `mdk <https://mdk.fr/>`_.
Feel free to ask your questions on ``#python-fr`` on `freenode Feel free to ask your questions on the ``#python-fr`` channel on `freenode
<https://webchat.freenode.net/>`_. <https://webchat.freenode.net/>`_ (does not require registration) or the
`AFPy traductions mailing list <https://lists.afpy.org/mailman/listinfo/traductions>`_.
Translation Resources Translation Resources