# Flyte 新人指南
作者:
- [Han-Ru Chen (Future-Outlier)](https://github.com/Future-Outlier)
- [Kevin Su (pingsutw)](https://github.com/pingsutw)

## 2023 and 2024 Flyte Committer 心得文
- [如何成為 Open Source Committer (Flyte) | 大學生21周心得分享](https://future-outlier.medium.com/如何成為open-source-committer-flyte-大學生21周心得分享-c1c486af6a9c)
- [普通人也能做到的 Open Source 開源一年 100+ PRs 完整指南 feat. 源來適你, Flyte](https://medium.com/@future-outlier/%E6%99%AE%E9%80%9A%E4%BA%BA%E4%B9%9F%E8%83%BD%E5%81%9A%E5%88%B0%E7%9A%84-open-source-%E9%96%8B%E6%BA%90%E4%B8%80%E5%B9%B4-100-prs-%E5%AE%8C%E6%95%B4%E6%8C%87%E5%8D%97-feat-%E6%BA%90%E4%BE%86%E9%81%A9%E4%BD%A0-flyte-87b1cc29f093)
- [貢獻開源並不難：我透過「源來適你」社群成為 Flyte 核心貢獻者！](https://chishengliu.com/zh-tw/posts/become-flyte-committer/)
- [開源入門到加入夢幻新創！](https://medium.com/@troychiu/from-flyte-to-union-ai-%E9%96%8B%E6%BA%90%E5%85%A5%E9%96%80%E5%BF%83%E5%BE%97-6ca2dc4cd6e4)
- [開源菜雞入門心得](https://medium.com/@hsw2000/%E9%96%8B%E6%BA%90%E8%8F%9C%E9%9B%9E%E5%85%A5%E9%96%80%E5%BF%83%E5%BE%97-fd54009ccf03)
- [Flyte開源之旅 — 從開始到現在](https://medium.com/@jasonlai1218/flyte%E9%96%8B%E6%BA%90%E4%B9%8B%E6%97%85-%E5%BE%9E%E9%96%8B%E5%A7%8B%E5%88%B0%E7%8F%BE%E5%9C%A8-efcf8afeb612)

## 如何找 issues
- 關注 Flyte github [issues](https://github.com/flyteorg/flyte/issues) - 上面有很多 union.ai 或是其他大公司開的 issues，如果有興趣還沒有被 assign 都可以直接在下面留言 `#take`, bot 會自動 assign issue 給你。如果 issue 不知道怎麼解或有問題，都可以直接 ping 開 issue 的人 (建立 connection 的好機會)。
- 測試 - 可以看 [codecov](https://app.codecov.io/gh/flyteorg/flyte) 的測試覆蓋率，目前還很低。幫忙加測試可以快速了解 codebase 跟累積 credits。通常加測試的 PR 也會很快被 merge。
- 增加新 feature - 當加一個新的 feature 的時候，通常會有很多 follow-up issues ，可以主動 reach out 做 feature 的人說你要幫忙。
- Documentation - 剛開始做開源的時候，可以先從改文件開始。現在很多文件不是很完整。剛開始在讀文件時，可以同時幫忙更新一些文件，一舉兩得。
- 改善 CI/CD ([github action](https://github.com/flyteorg/flyte/pull/5827/checks?check_run_id=31324607806)) - 當你發 PR 的時候下面跑的 tasks，包括測試，build image，build 文件。 有幾個可以 improve 的點
- 減少 build image 的時間 (加 cache)
- 減少 install packages 的時間 (加 cache, 用 [uv](https://github.com/astral-sh/uv))
- 讓測試跑更快 (一次跑多個測試)
- 增加系統穩定性 (aka 修 Bugs) - 剛開始在測試或是開發的時候一定都會發現一些奇怪 bug ，知道怎麼解的話可以直接 create 一個 PR，不知道的話，可以先發個 issue ，然後跟社群討論。
- Improve UX - 簡單來說，就是讓 flyte 更簡單易用，別人不用讀 document 就知道怎麼用。 當你在用 client API 的時候 (flytekit, flytectl, pyflyte run) ，如果發現哪邊難用的地方，可以發個 issue 然後大家討論怎麼改進，通常你覺得難用，其他人也會覺得難用。For example
- 用 image spec 來 build image
- `fast_register_workflow` in flytekit remote ([PR](https://github.com/flyteorg/flytekit/pull/2303))
- Improve devx - 讓開發更間單快速。For example
- 用[腳本](https://github.com/flyteorg/flyte/blob/master/flyteidl/generate_protos.sh)來生成 idl 的 code
- [make lint](https://github.com/flyteorg/flytekit/blob/51751ebb5b2aaa62264e094b8987d86214350283/Makefile#L37) 自動 format code
- [single binary](https://docs.flyte.org/en/latest/community/contribute.html#how-to-setup-dev-environment-for-flyteidl-flyteadmin-flyteplugins-flytepropeller-datacatalog-and-flytestdlib) 讓 developer 在本地跑 flyte cluster
- Improve Performance - 通常這會比較難，要對整個系統比較熟，才會知道怎麼改進。可以先用一些工具來 profile 像是 ([flameprof](https://pypi.org/project/flameprof/), [prometheus](https://prometheus.io/)) 。有幾個可以下手的地方：
- 讓 pyflyte run/reigster 更快
- admin server 有些 data 可以 cache 起來，不用每次跟 DB 要資料
- 降低 database 的 overhead (Add index to the table, update query, etc)
- IO-bound 的地方，可以嘗試用 async 來處理 (參考 austin 的 [PR](https://github.com/flyteorg/flytekit/pull/2276))
- CPU-bound 的地方，可以嘗試用 multi-thread 處理

## 規則
1. 所有問題都丟大群 union 籃球隊，避免私訊

## 第一階段
- [setup dev 環境](https://docs.flyte.org/en/latest/community/contribute/contribute_code.html#how-to-setup-dev-environment-for-flyteidl-flyteadmin-flyteplugins-flytepropeller-datacatalog-and-flytestdlib)
- 把以下看完，並試著挑10個範例跑
- https://docs.flyte.org/en/latest/user_guide/introduction.html
- https://docs.flyte.org/en/latest/flytesnacks/userguide.html
- 把 [Concepts看完](https://docs.flyte.org/en/latest/user_guide/concepts/main_concepts/index.html)

## 第二階段
- 把 [Control Plane看完](https://docs.flyte.org/en/latest/user_guide/concepts/control_plane/index.html)
- 把 [Component Architecture看完](https://docs.flyte.org/en/latest/user_guide/concepts/component_architecture/index.html)
- 從以下挑2個 good first issue，開始用讀過的知識來解他們
- https://github.com/flyteorg/flyte/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22
- https://docs.google.com/document/d/1kQgGRuIfUxawYiIHiawBw0bavBig1u-im1MW1KWXhio/edit#heading=h.ocfq7k4lew7g

## 第三階段
- 熟悉使用 ImageSpec push image 到 localhost的開發方式
- 研究第二周選的任務，並用上面學到的方法試著做出來

## 如何 build doc?
Flyte 的 Doc 主要有兩個地方，一個在 Flyte, 一個在 flytesnacks.
舉我最近改 dataclass DOC PR 為例

flytesnacks: https://github.com/flyteorg/flytesnacks/pull/1747
flyte: https://github.com/flyteorg/flyte/pull/5829/files

flytesnacks 中所有 `# xxxxx` 這種 python 註解大部分都不會被 import 到，
你會發現它跟 Flyte 有些地方有重複到，現在會顯示的是在 Flyte 這邊。

### flyte
怎麼改就有樣學樣找規律＋問 ChatGPT，我真的是這樣學過來的。

提供 docs link 會讓 Reviewers 更好 Review, 可以去找 url 的規律。
舉例來說：
https://flyte-\-5829.org.readthedocs.build/en/5829/user_guide/data_types_and_io/dataclass.html

會有 5829 這個數字出現，因為這是第 5829 個 PR, 剩下的 suffix 可以開官方的 doc 對照
https://docs.flyte.org/en/latest/user_guide/data_types_and_io/dataclass.html
取出這段
"user_guide/data_types_and_io/dataclass.html"

### flytesnacks
就改 example code, 發 PR 前要使用 `make fmt`.
(可以養成看 Makefile 的習慣，這樣才知道有哪些功能常用)

### 注意事項
1. `:lines:` 要對準
2. 使用 gitsha 指定 example code 很重要，不要用 master，因為這樣才能確保結果 100% 正確
3. 用發 PR 的方式 build doc, 不要在自己本地 build, 只要發 PR Trigger CI 就會開始 build，
在 flyte 有一個 CI 叫做 "docs/readthedocs.org:flyte"，看這個
4. flytesnacks 發 PR 前要使用 `make fmt`
5. 上傳 commmit 之前，要用 `git commit -s`，第一次提交大家都會忘記要 sign-off
6. 上傳前記得用 `codespell 你改的file`，檢查有沒有拼字錯誤
7. 有 reference code, 照片，記得用 gitsha + github raw content