French translations

[JulianMaurin]

Bonjour 🇫🇷

Welcome to the issue that coordinates the French translation effort.

Purpose

• Avoiding several people working on the same document at the same time.

The first person who declares that he/she is working on a translation gets the responsibility to carry it out. If a PR seems to be stalled, we can discuss a transfer of responsibility here.

• Enforcing best practices

Best practices are listed later in this description. You can propose your practice at any time, ideally with a supporting source and an example.

Defining and sharing best practices will help to avoid common mistakes and will allow faster and easier reviews.

• Help and build the community

Do not hesitate to ask any questions regarding the french translation effort here. The stronger the community, the more effective we will be and the more we will enjoy.

• Provide a french translation for this awesome library (last but not least)

If you are here, you probably like FastAPI, and maybe you even speak French. Giving more people the opportunity to get started using the documentation in its native language will encourage adoption. In that spirit, let's contribute to the magic of open source in this way.

How to contribute

Review

Keep in mind that the easiest way to participate is to review the PRs. We need to avoid accumulating PRs waiting for review.

Translate

If you are not familiar with contributing to open source projects have a look at https://github.com/firstcontributions/first-contributions.

In any case, take a look at the documentation section related to the contribution and more precisely the part about the documentation.

Once you are decided to translate a document, make yourself known here by leaving a message here (eg. #1972 (comment)).

Organize

If you wish, your energy is welcome to help with the organization. Bringing together motivated people and helping them get the job done is essential. Moreover, we can surely learn a lot from the translation work of other languages that are much more advanced and we can have a significant impact if we put good processes in place that can help the whole community

Good practices

• technical terms

Technical terms do not need to be translated. It is also a question of common sense, in certain conditions English can be preferred because the French version is not in use.
See: #1972 (comment)

• punctuation and typography

For example, missing whitespace before/after punctuation. You can rely on this page to help you.
see: #1973 (comment)

• structure the PR by commit

Splitting the commit will ease the review and helps to track the change on the original documentation while the PR is open.
(see: example).

The first commit should only contain the copy of the English version of the document to the french one. With the exact same content (eg. 30f1dd6).

The second one is dedicated the index update (eg. 8ff5f7a)

And starting from this point you can start the translation. Notice that, thanks to this structure we can directly compare the two languages (eg. 3729f5b).

Also, if the English document got updated, we just have to update the first commit and the conflicts will reveal updated part of the document 🪄

Recommended tools

• https://www.deepl.com
• https://www.linguee.fr
• https://www.wordreference.com
• https://french.stackexchange.com

[JulianMaurin]

I'm starting with the docs/index.md: #1973

[Jefidev]

Hello, I would like to help with this but it is the first time I contribute to an open-source project. Could you summarize me the workflow to correctly push the update ?

[Kludex]

@Jefidev

• Post here the page you'll be translating.
• Work on it.
• Create the PR with your work.
• Developers will review.
• Fix issues/get approvals.
• Wait for enough approvals (usually 2-3 are enough based on what I've seen).
• @tiangolo will merge if everything is fine.

[Jefidev]

Thanks, So I am translating the features.md docs/features.md page

[JulianMaurin]

Hey @Jefidev , to contribute you can also review the existing PR :)
Thanks for you motivation ✌️

[JulianMaurin]

I take the docs/contributing.md 💪
cf. #2132

[Jefidev]

Hi,
Ok I will also check the PR. I just want to be clear on some convention. Do you translate python types.
For instance Dict => dictionnaires
I did it but as a programmer even if my main language is french I refer to them as Dict.

For very specific technical terms I decided to do the same thing as the Spanish translator. They translate the terms but add an note with the English technical term.

Here are the technical terms for which I cannot find a propper translation :

• In-process background tasks.
• path operations

[clemsau]

I am taking on docs/benchmarks.md.

[JulianMaurin]

I'll work on docs/fastapi-people.md :)
cf. #2232

[JulianMaurin]

The next one is: help-fastapi.md 🚀
cf. #2233

[JulianMaurin]

Hi @Jefidev

I just want to be clear on some convention. Do you translate python types.
For instance Dict => dictionnaires
I did it but as a programmer even if my main language is french I refer to them as Dict.
For very specific technical terms I decided to do the same thing as the Spanish translator. They translate the terms but add an note with the English technical term.

IMHO.
There is no reason to translate python keywords (eg. dict, package, method, ...).
In the other and, we have to translate the English word "dictionary" even when it's used in a technical context.

For the specifics technicals terms, you have to identify if there is an equivalent term in french. But most of the time when we are speaking about technical concepts, the usage of English could not be avoided.

My idea about a translated technical documentation is that it's just to make it easier for people to get into the library. We can assume that the reader will have a technical background and will not be confused by the presence of English technical terms.

[Jefidev]

Hi 😃
I did not translate the words making reference to a python keyword (as you mentioned them dict, package, etc.) or the ones that are common in programming.

For the technical terms, I decided to take a look at the Spanish translation (because it is the most advanced yet but we are coming). They decided to translate the technical terms and display the English terms when hoovering (with the <abbr> tag). I follow that convention for my features.md translation.
For example, I decided to translate Background Tasks by Tâches d'arrière plan. But I decided to keep the words path in English as they should be familiar to the people designing API.

I am keen to discuss this issue more in-depth in order to have a strong convention for the French Translation Team.

[JulianMaurin]

And now tutorial/index.md 💪
cf. #2234

[JulianMaurin]

I am keen to discuss this issue more in-depth in order to have a strong convention for the French Translation Team.

Yes, perfect. Let's confront our choices during the reviews, and report the conventions here :)
(by the way, i'll do a small break in translations for now to do some reviews 👀 )

[rjNemo]

Hello,

what is the current status of the French translation?

I would like to contribute starting with docs/alternatives.md

[Kludex]

You can go for it. There's also a need for review on the other pages.

[rjNemo]

Super. I will give them a look too

[Smlep]

Hi,

I'll work on tutorial/background-tasks.md.

Edit: done (#3098)

[Smlep]

Hey 👋,

I'll work on external-links.md now.

Edit: done (#3103)

[NastasiaSaby]

Hello 👋 😃.

I can do tutorial/testing.md.

Edit: done (#3172)

[rjNemo]

It’s nice to see you back here!

[JulianMaurin]

description updated, open to suggestions 🖖

[axel584]

Bonjour,
J'aimerai aider à la traduction de la documentation de FastAPI, mais je ne m'y connais pas trop en projet Open Source, j'ai plutôt l'habitude de contribuer sur un repo unique où j'ai des droits d'écriture. Du coup, je me posais pas mal de questions sur les review de PR :

• Faut-il corriger/suggérer des modifications avec des commentaires dans la PR ? ou bien faire un commit de nos modifs ? (si oui, faut-il forker le repo du traducteur ou celui de tiangolo ?)
• Comment "approuver" une PR ? Faut-il des droits particuliers ? Je ne vois rien qui semblerait me permettre d'approuver des PR, ni sur celles ouvertes, ni sur celles déjà mergées.
• Y'a t'il des pages de doc à traduire en priorité ? (j'ai l'impression que certaines pages importantes semblent bloquées en attente d'approbation. Quand je recherche "french" dans les PR encore ouvertes, j'en trouve 13)

J'ai essayé de trouver des conseils un peu partout, mais en général, ça explique surtout le workflow fork/code/merge, et assez peu la partie "approbation d'une PR" par la communauté. Merci pour vos conseils.

[axel584]

I just translate docs/fr/docs/advanced/additional-status-code.md. But I've small problem with codecov... some test don't pass and I don't know why...

[rjNemo]

Hi @axel584, thanks for contributing! 👏

To have an idea of how to contribute the best would be to review open PRs.
You will see what files to update and what terms we usually use.

If you have suggestions, leave a comment the PR author is responsible for accepting them.

To approve a PR, go to the 'Files changed tab', then click on 'review changes' green button, and select 'approve' before submitting your review.

[axel584]

I wanted to translate advanced/additional-responses.md but when I commit/push my translation, this updated my first PR... So, I think it's better not to translate more in the meantime...

About review, I approve some of them (about deployment) but the others are pretty old... and seem to have conflict.

[JulianMaurin]

Hey @axel584 👋
Thanks for your motivation! I'll have a look at your first translation :)

when I commit/push my translation, this updated my first PR

Did you create a new branch? Are you comfortable with git?

About review, I approve some of them (about deployment) but the others are pretty old... and seem to have conflict.

Do not hesitate to ping people on the PR to signal the conflict or to ask about news :)

PS: if you plan to translate a new page, it would be awesome if you follow the structure the PR by commit process (see), it would help a lot to review 🙇

[axel584]

@JulianMaurin : thank you for your advice. I'm not used to working on projects with pull requests between different repositories. But thanks to your advice, I should be able to do better in the future. The process explained seems very clear and very practical. I'm sorry for not being more attentive. The ability to compare line by line is really great to be able to check a translation. Thanks again !

[axel584]

I'll translate the advanced/index.md (and i'll try to follow the good practice 😅 )

[axel584]

@JulianMaurin / @rjNemo : I need a review for my PR and I didn't understand if I forgot something : #5477
Thank your for your help or yours advices.

[github-actions]

Good news everyone! 😉 There's a new translation PR to be reviewed: #5477 🎉

[axel584]

I will work on the files of the advanced section. Do not hesitate to contact me if you wish to translate pages from this section. I will take the pages in the order in which they appear on the documentation.

[github-actions]

Good news everyone! 😉 There's a new translation PR to be reviewed: #5701 🎉

[github-actions]

Good news everyone! 😉 There's a new translation PR to be reviewed: #5673 🎉

[cfraboulet]

Bonjour @JulianMaurin / @rjNemo 👋

I would like to help you with the translation of the FastAPI documentation into French 😊

After reading the issue and the different best practices, I saw that there were still some PRs not merged (11 in total). Is there any need for review?

I can also start translating pages, like for example with tutorial/debugging.md?

Thanks for your help 🙏

[rjNemo]

Hi @frabc 👋 ,
Sure, reviews would be very appreciated.

Then feel free to start translating 😄

[cfraboulet]

Hi @rjNemo 👋

Thanks for the answer 🙂 A PR to be taken in priority or can I take the list of PR still open?

[cfraboulet]

I'll work on docs/tutorial/debugging.md :)

Edit: done (#9175) @axel584 @rjNemo @JulianMaurin

For this first PR, I have two points on which I had a hesitation:

• I translated the words debugging and debugger into French, I hesitated to leave it in English.
• I left in English some words in the part explaining how to launch the debugger in VS Code and Pycharm because on my laptop even with a French OS I have the menus in English in these two IDE.

[axel584]

Don't hesitate to ping me to review your PR.
You'll need 2 reviewer to approve your work.

Axel