工程开发
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日 22:27
在 GitHub 查看