工程開發
project-guidelines-example avatar

project-guidelines-example

專案專屬的架構指南模板,提供生產級 AI 應用程式的標準化結構、代碼模式、測試要求及部署工作流程。

簡介

專案指南技能是一個全面的操作模板,旨在協助工程團隊在生產級軟體專案中實現標準化的開發流程。該技能汲取了 Zenith 等實際平台的架構經驗,封裝了關鍵的專案知識,包括架構圖、技術堆疊設定、檔案結構規範以及標準化的程式碼模式。它作為一個基準點,確保團隊在整個軟體開發生命週期中保持一致的代碼品質與最佳實踐。

  • 標準化技術堆疊:包含針對 Next.js 15、FastAPI、Supabase 與 Claude API 整合的設定指引。

  • 架構規劃:清晰定義前端與後端服務之間的服務導向圖譜與通訊流程。

  • 程式碼規範:提供具體的 API 回應處理、前端請求與利用 Pydantic 和 TypeScript 進行結構化 AI 輸出分析的實現範本。

  • 自動化測試與部署:內建 pytest、Playwright 與 React Testing Library 的測試指令集,並包含針對 Google Cloud Run 生產環境部署的檢核清單。

  • 適用於需要快速啟動新儲存庫並採用久經考驗之架構模式的開發人員。

  • 強制執行嚴格的編碼約束:禁止表情符號、採用測試驅動開發 (TDD)、維護 80% 以上測試覆蓋率及模組化檔案架構。

  • 預期輸入:專案需求與技術決策;輸出內容:結構模板、配置腳本與文件最佳實踐。

  • 注意事項:嚴格遵守不可變性原則,禁止在生產環境程式碼中使用 console.log,確保程式碼庫乾淨且易於維護。

  • 關鍵詞:軟體架構、FastAPI、Next.js 15、Pydantic、TypeScript、CI/CD、生產工程、代碼標準、自動化測試。

倉庫統計

Star 數
0
Fork 數
0
Open Issue 數
2
主要語言
TypeScript
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月3日 下午10:27
在 GitHub 查看