Agent skill · software engineering · affaan-m

project-guidelines-example

Project-specific skill template covering architecture, patterns, testing, and deployment guidance.

Why this skill is useful

Provides specific architectural patterns, deployment workflows, and code examples that the AI wouldn't reliably generate on its own.

What it needs

Requires fastapi, nextjs, playwright, pytest, react, supabase installed locally. About 3k tokens when loaded. Last updated 2026-08-06. 238,342 stars on the source repository.

What this skill does

專案指南技能(範例) 這是專案特定技能的範例。使用此作為你自己專案的範本。 基於真實生產應用程式:Zenith - AI 驅動的客戶探索平台。 --- 何時使用 在處理專案特定設計時參考此技能。專案技能包含: 架構概覽 檔案結構 程式碼模式 測試要求 部署工作流程 --- 架構概覽 技術堆疊: 前端:Next.js 15(App Router)、TypeScript、React 後端:FastAPI(Python)、Pydantic 模型 資料庫:Supabase(PostgreSQL) AI:Claude API 帶工具呼叫和結構化輸出 部署:Google Cloud Run 測試:Playwright(E2E)、pytest(後端)、React Testing Library 服務: --- 檔案結構 --- 程式碼模式 API 回應格式(FastAPI) 前端 API 呼叫(TypeScript) Claude AI 整合(結構化輸出) 自訂 Hooks(React) --- 測試要求 後端(pytest) 測試結構: 前端(React Testing Library) 測試結構: --- 部署工作流程 部署前檢查清單 [ ] 本機所有測試通過 [ ] npm run build 成功(前端) [ ] poetry run pytest 通過(後端) [ ] 無寫死密鑰 [ ] 環境變數已記錄 [ ] 資料庫 migrations 準備就緒 部署指令 環境變數 --- 關鍵規則 1. 無表情符號 在程式碼、註解或文件中 2. 不可變性 - 永遠不要突變物件或陣列 3. TDD - 實作前先寫測試 4. 80% 覆蓋率 最低 5. 多個小檔案 - 200-400 行典型,最多 800 行 6. 無 console.log 在生產程式碼中 7. 適當錯誤處理 使用 try/catch 8. 輸入驗證 使用 Pydantic/Zod --- 相關技能 coding-standards.md - 一般程式碼最佳實務 backend-patterns.md - API 和資料庫模式 frontend-patterns.md - React 和 Next.js 模式 tdd-workflow/ - 測試驅動開發方法論

How to use it

Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:

@skills affaan-m/project-guidelines-example--0c321a

View the source on GitHub

Browse the @skills marketplace