跳至主要内容

Start Here

這條路徑讓你不用先讀完整 docs/ 樹,也能快速知道 tachigo 怎麼運作、哪些地方最常改、哪些流程跨到 tachiya。

First hour

順序讀什麼你要帶走的 mental model
1Dev Portal Hometachigo API 是核心 boundary;extension、dashboard、tachiya 都圍繞它協作。
2系統整體架構client layer、Go backend、PostgreSQL、tachiya / Saleor、chain 的角色分工。
3Domain Maps先掌握 Points、Auth、Extension 三個 P0 domain。
4Cross-Repo Flows看 watch flow 與 coupon redemption flow 如何跨 repo。

First day

任務路徑檢查點
跑起本機服務make devDocker compose 會啟動 API 與前端服務。
看 API 入口services/api/internal/router/router.go確認 public、auth、internal route 怎麼分層。
看 extension heartbeatapps/extension/src/hooks/useHeartbeat.tsviewer activity 如何回報到 API。
看 dashboard 入口apps/dashboard/src/App.tsxRefine / React Router resource 如何對上 API。
看 tachiya 邊界Coupon redemption flowtachigo 扣點,tachiya 保護 Saleor commerce logic。

First PR

  1. 先找 issue,確認 scope 只做 source of truth 明確要求的事情。
  2. Daily Dev Guide 找對應 domain 的 source、tests、policy。
  3. 若改 API handler,確認 Swagger / shared types / frontend assumptions 是否需要一起更新。
  4. 若改 package dependency,讀 Supply-chain Security Guardrails,PR body 必須說明套件、版本、用途與 guardrail。
  5. 開 PR 前跑最小可驗證命令,並在 PR template 的 Acceptance Criteria / 測試方式寫清楚。

常見方向

我要做什麼從這裡開始
改觀看累點、ledger、餘額Points / ledger / watch time
改 login、JWT、provider、roleAuth / identity
改 sidepanel UI 或 heartbeatExtension / sidepanel
查跨 tachiya 的折扣碼流程Coupon redemption flow
找文件或 plan 的位置Source Index