项目模板
遵循2025-2026年人工智能增强开发行业标准的现代Python首个项目模板。生产项目中经过实战检验的模式。
包含什么
AI代理配置
| 文件 | 标准 | 支持 |
|---|
AGENTS.md | AAIF/Linux基金会 | Claude、Copilot、Cursor、Codex、Devin、Gemini CLI |
CLAUDE.md | 拟人 | 克劳德代码(带文档路由器+信任级别) |
.claude/ | Claude代码预设 | 技能(/commit、/push)、挂钩、权限 |
.cursor/rules/ | 光标 | 光标AI |
.github/copilot-instructions.md | GitHub | GitHub副本 |
.well-known/agent-card.json | A2A协议 | 代理间通信 |
克劳德代码预设(.claude/)
为保持代理行为一致而预设的生产就绪:
| 文件 | 目的 |
|---|
settings.json | 权限(git、python、pytest、pip、gh)+钩子配置 |
hooks/protect-files.py | 阻止编辑 .env,秘密,锁定文件, .git/ |
skills/commit/SKILL.md | 智能提交与常规提交+共同作者 |
skills/push/SKILL.md | 为未经测试的功能自动创建GitHub问题 |
.gitignore | 从git中排除本地设置和会话数据 |
开发标准(docs/core/)
26个经过生产测试的标准(Python优先):
| 类别 | 文档 | 信任级别 |
|---|
| 基础 | 项目指南、测试策略、Git工作流、信任级别、自我验证、文档、最佳实践、Python工具、预设指南 | 1(自动) |
| 建筑 | 接口契约、服务层、错误处理、API设计、性能、性能模式、配置、日志记录、依赖关系、部署、代理优化、技能架构、服务器设置 | 2(AI审查) |
| 关键的 | 安全、数据库策略、人工智能治理 | 3(人类评论) |
项目管理
| 文件夹 | 用途 |
|---|
tasks/ | 任务跟踪(活动、积压、完成) |
docs/decisions/ | 带模板+实例的架构决策记录(ADR) |
docs/specs/ | 功能规范(规范驱动开发) |
docs/guides/ | 设置和部署指南 |
context/ | 业务背景、市场调研、领域知识 |
data-sources/ | 原始/源数据(gignored) |
开发运维
| 文件 | 目的 |
|---|
.github/workflows/ci.yml | CI管道模板 |
.github/ISSUE_TEMPLATE/ | Bug、功能和想法模板 |
.github/PULL_REQUEST_TEMPLATE.md | PR模板 |
scripts/validate.sh | 提交前验证(ruff、mypy、pytest) |
CONTRIBUTING.md | 贡献指南 |
SECURITY.md | 安全策略 |
CHANGELOG.md | 版本历史 |
快速开始
- 点击 “使用此模板” 在GitHub上
- 填写
AGENTS.md 和 CLAUDE.md 使用您的项目详细信息(替换TODO) - 审查
.claude/settings.json --调整堆栈的权限 - 设置
docs/architecture/overview.md 根据您的系统设计 - 开始向添加任务
tasks/backlog.md - 跑
./scripts/validate.sh 验证您的设置
目录结构
.
├── AGENTS.md # Universal AI agent instructions (AAIF standard)
├── CLAUDE.md # Claude Code instructions (Documentation Router + Trust Levels)
├── README.md # This file
├── CONTRIBUTING.md # How to contribute
├── CHANGELOG.md # Version history
├── SECURITY.md # Security policy
├── .editorconfig # Editor settings
├── .gitignore # Git ignore rules
├── .env.example # Environment template
│
├── .claude/ # Claude Code preset
│ ├── settings.json # Permissions + hooks
│ ├── .gitignore # Local files exclusion
│ ├── hooks/
│ │ └── protect-files.py # Block edits to sensitive files
│ └── skills/
│ ├── commit/SKILL.md # /commit command
│ └── push/SKILL.md # /push command
│
├── .cursor/rules/ # Cursor AI rules
├── .github/ # GitHub config (CI, templates, Copilot)
├── .well-known/ # A2A agent discovery
│
├── docs/
│ ├── core/ # 26 development standards (Python-first)
│ ├── architecture/ # System design
│ ├── decisions/ # ADRs (template + example)
│ ├── specs/ # Feature specifications
│ └── guides/ # Setup, deployment guides
│
├── tasks/
│ ├── backlog.md # Ideas and future tasks
│ ├── active/ # Tasks in progress
│ └── done/ # Completed tasks archive
│
├── context/ # Business context
│ ├── company/ # Company info
│ ├── market/ # Market research
│ └── products/ # Product details
│
├── scripts/
│ └── validate.sh # Pre-commit validation (ruff, mypy, pytest)
│
├── data/ # Application data (partially gitignored)
├── data-sources/ # Raw/source data (fully gitignored)
├── src/ # Source code
└── tests/ # Tests (unit, integration)
信任级别
| 级别 | 回顾 | 示例 |
|---|
| 1 | 自动审批 | UI更改、按模式CRUD、文档、测试 |
| 2 | AI评论 | 新的API端点、业务逻辑、集成 |
| 3 | 人工审核 | 授权、支付、数据库迁移、加密 |
开放任务
- \[ \] 设计系统/UI方法 --Python web项目的统一设计系统(Jinja2+Alpine.js+HTMX+Tailwind)尚未标准化。需要单独规划。
标准参考
许可证
选择许可证