]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commitdiff
:memo: Update contributing guidelines to review translation PRs (#1215)
authorSebastián Ramírez <tiangolo@gmail.com>
Sat, 4 Apr 2020 20:36:10 +0000 (22:36 +0200)
committerGitHub <noreply@github.com>
Sat, 4 Apr 2020 20:36:10 +0000 (22:36 +0200)
docs/en/docs/contributing.md

index 57767f4884fda71fb1aa037c1ffa9d2741b98919..66fc8efc9fd92c1721ebd3c1eca73c84d6c4e734 100644 (file)
@@ -257,7 +257,16 @@ Here are the steps to help with translations.
 
 #### Tips and guidelines
 
-* Add a single Pull Request per page translated. That will make it much easier for others to review it.
+* Check the currently <a href="https://github.com/tiangolo/fastapi/pulls" class="external-link" target="_blank">existing pull requests</a> for your language and add reviews requesting changes or approving them.
+
+!!! tip
+    You can <a href="https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request" class="external-link" target="_blank">add comments with change suggestions</a> to existing pull requests.
+
+    Check the docs about <a href="https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews" class="external-link" target="_blank">adding a pull request review</a> to approve it or request changes.
+
+* Check in the <a href="https://github.com/tiangolo/fastapi/issues" class="external-link" target="_blank">issues</a> to see if there's one coordinating translations for your language.
+
+* Add a single pull request per page translated. That will make it much easier for others to review it.
 
 For the languages I don't speak, I'll wait for several others to review the translation before merging.
 
@@ -385,6 +394,11 @@ Updating en
 
 Now you can check in your code editor the newly created directory `docs/ht/`.
 
+!!! tip
+    Create a first pull request with just this, to set up the configuration for the new language, before adding translations.
+
+    That way others can help with other pages while you work on the first one. 🚀
+
 Start by translating the main page, `docs/ht/index.md`.
 
 Then you can continue with the previous instructions, for an "Existing Language".