嗨你好,我是 Max,很歡迎你一起參與 FastAPI 繁體中文翻譯計畫,希望這份紀錄對你在開始第一篇翻譯時有幫助 🙂
Table
ㄧ. 起手式 Fork FastAPI
首先到 FastAPI (https://github.com/tiangolo/fastapi),點擊右上角的 Fork 專案

接下來到本地終端機 git clone 剛剛 fork 的自己 FastAPI 專案
1 2 3 4 5 6 7 8 9 |
> git clone git@github.com:hsuanchi/fastapi.git Cloning into 'fastapi'... remote: Enumerating objects: 32920, done. remote: Counting objects: 100% (749/749), done. remote: Compressing objects: 100% (63/63), done. remote: Total 32920 (delta 716), reused 695 (delta 686), pack-reused 32171 Receiving objects: 100% (32920/32920), 19.42 MiB | 1.29 MiB/s, done. Resolving deltas: 100% (23303/23303), done. |
然後建立一個新的分支 (git checkout -b
),我這邊將分支命名為 zh-hant
1 2 3 |
> cd fastapi > git checkout -b zh-hant Switched to a new branch 'zh-hant' |

二. 開始翻譯 & 測試
選擇這次想要翻譯的文件,這次我們選擇的是翻譯 docs/en/docs/learn/index.md 的內容,接下來我們在 docs/zh-hant/docs/learn/index.md 也建立了一樣的檔案,並且翻譯成繁體中文!

建立測試環境:
1 2 3 4 5 |
> python -m venv env > source ./env/bin/activate > python -m pip install --upgrade pip > pip install -r requirements.txt |
啟動 mkdocs serve
1 2 3 |
> cd docs/zh-hant/ > mkdocs serve --dev-addr 127.0.0.1:8008 |
如果一切順利的話,就會看到剛剛的畫面囉!

三. 發 Pull Request
首先我們 git add、git commit、git push 剛剛所修改的內容

回到剛剛 fork 的專案頁面,點擊 pull request (如下圖)

填寫 Pull request 資訊 (如下圖),並點擊 Create pull request 的按鈕

最後,等待兩位 reviewer 審核!都沒問題後作者就會 merge 進 main 囉!

關於更多 FastAPI 的 contributing 可以參考這篇:
感謝您收看「FastAPI Contributor 繁體中文翻譯計畫」,任何問題都很歡迎透過以下私訊,我會盡快回覆您。