Skip to content

Commit 5e1dfe7

Browse files
committed
More detail about contributing with github.
1 parent 0d8c24f commit 5e1dfe7

File tree

1 file changed

+31
-14
lines changed

1 file changed

+31
-14
lines changed

README.rst

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,31 @@ Contributing to the Translation
3232
How to Contribute
3333
~~~~~~~~~~~~~~~~~
3434

35-
You can either contribute on `transifex/python-doc/public
36-
<https://www.transifex.com/python-doc/public/>`_, or by simply openning an
37-
issue on this repository, or by editing the ``po`` files.
35+
You contribute using:
3836

39-
To modify those files you first have to fork this project and follow
40-
github instructions to clone it.
37+
- github (preferred solution)
38+
- `transifex <https://www.transifex.com/python-doc/public/>`_
39+
- Or just by opening `an issue on github <https://github.com/python/python-docs-fr/issues>`_
4140

42-
Next, to edit the files, you can use an editor of your choice, there's many:
4341

44-
- Highly recommended: `poedit <http://www.poedit.net/>`_
42+
Contributing using Github
43+
~~~~~~~~~~~~~~~~~~~~~~~~~
44+
45+
You'll first need a `github account <https://github.com/join>`_.
46+
47+
Then you'll need to fork the project by clicking the ``Fork`` button
48+
on `python-docs-fr <https://github.com/python/python-docs-fr>`_. This
49+
creates a copy of the whole project on your github account: a place
50+
where you have the rights to do modifications.
51+
52+
To modify po files you'll need to synchronize the project files to
53+
your computer by using ``git``: https://help.github.com/articles/set-up-git/.
54+
55+
Once the project ``git clone``ed, you'll be able to modify the files
56+
containing the translations, those are ``.po`` files and can be
57+
modified using various tools:
58+
59+
- `poedit <http://www.poedit.net/>`_ (recommended)
4560
- gted
4661
- gtranslator
4762
- lokalize
@@ -53,12 +68,13 @@ Next, to edit the files, you can use an editor of your choice, there's many:
5368
Before commiting, you should use `grammalecte
5469
<https://www.dicollecte.org/>`_ to check for your translations.
5570

56-
Finally, once your contribution is done, do a ``pull request`` so we
57-
can review and merge it.
71+
After commiting (this is just "naming the modification"), synchronize
72+
the file back to github using ``git push``.
5873

59-
Please write your issues and pull requests in english for consistency
60-
with the python github organization and because non-french people may
61-
receive github notifications about our activity.
74+
And now, from your github project, a buttun should appear "Create a
75+
pull requests", this is asking us, the main project, to pull your
76+
modifications. This step may take some time as we'll review your
77+
modifications before accepting them, and we may ask for modifications.
6278

6379

6480
What to translate
@@ -86,8 +102,9 @@ Where to get help
86102

87103
The coordinator for this translation is `mdk <https://mdk.fr/>`_.
88104

89-
Feel free to ask your questions on ``#python-fr`` on `freenode
90-
<https://webchat.freenode.net/>`_.
105+
Feel free to ask your questions on the ``#python-fr`` channel on `freenode
106+
<https://webchat.freenode.net/>`_ (does not require registration) or the
107+
`AFPy traductions mailing list <https://lists.afpy.org/mailman/listinfo/traductions>`_.
91108

92109

93110
Translation Resources

0 commit comments

Comments
 (0)