Skip to content

Commit 3f2c15e

Browse files
committed
Update docs for contributors and team members regarding translation PRs
1 parent 64feaec commit 3f2c15e

2 files changed

Lines changed: 15 additions & 2 deletions

File tree

docs/en/docs/contributing.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,11 @@ If you see mistakes in your language, you can make suggestions to the prompt in
191191

192192
#### Reviewing Translation PRs
193193

194-
You can also check the currently [existing pull requests](https://github.com/fastapi/fastapi/pulls) for your language. You can filter the pull requests by the ones with the label for your language. For example, for Spanish, the label is [`lang-es`](https://github.com/fastapi/fastapi/pulls?q=is%3Aopen+sort%3Aupdated-desc+label%3Alang-es+label%3Aawaiting-review).
194+
We don’t require approval from native speakers for translation PRs generated automatically by our translation workflow. However, you can still review them and suggest improvements to the LLM prompt for that language to make the future translations better.
195+
196+
You can check the currently [existing pull requests](https://github.com/fastapi/fastapi/pulls) for your language. You can filter the pull requests by the ones with the label for your language. For example, for Spanish, the label is [`lang-es`](https://github.com/fastapi/fastapi/pulls?q=is%3Aopen+sort%3Aupdated-desc+label%3Alang-es+label%3Aawaiting-review).
197+
198+
You can also review already merged translation PRs. To do this, go to the [closed pull requests](https://github.com/fastapi/fastapi/pulls?q=is%3Apr+is%3Aclosed) and filter by your language label. For example, for Spanish, you can use [`lang-es`](https://github.com/fastapi/fastapi/pulls?q=is%3Apr+is%3Aclosed+label%3Alang-es).
195199

196200
When reviewing a pull request, it's better not to suggest changes in the same pull request, because it is LLM generated, and it won't be possible to make sure that small individual changes are replicated in other similar sections, or that they are preserved when translating the same content again.
197201

@@ -203,6 +207,8 @@ Check the docs about [adding a pull request review](https://help.github.com/en/g
203207

204208
///
205209

210+
PRs with suggestions to the language-specific LLM prompt require approval from at least one native speaker. Your help here is very much appreciated!
211+
206212
#### Subscribe to Notifications for Your Language
207213

208214
Check if there's a [GitHub Discussion](https://github.com/fastapi/fastapi/discussions/categories/translations) to coordinate translations for your language. You can subscribe to it, and when there's a new pull request to review, an automatic comment will be added to the discussion.

docs/en/docs/management-tasks.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,14 @@ For these language translation PRs, confirm that:
114114

115115
* The PR was automated (authored by @tiangolo), not made by another user.
116116
* It has the labels `lang-all` and `lang-{lang code}`.
117-
* If the PR is approved by at least one native speaker, you can merge it.
117+
118+
For PRs that update language-specific LLM prompts, confirm that:
119+
120+
* The PR has the labels `lang-all` and `lang-{lang code}`.
121+
* It is approved by at least one native speaker.
122+
* In some cases you might need to translate several pages with new prompt to make sure it works as expected.
123+
124+
If the PR meets the above conditions, you can merge it. 😎
118125

119126
## Review PRs
120127

0 commit comments

Comments
 (0)