模板使用说明
本仓库是公司项目模板。使用模板创建新项目后，必须把本文件中的项目名称、说明、环境要求和所有
TODO命令替换成项目真实内容；不适用的章节应删除或改写。维护
project_template仓库时，本文件中的TODO是模板占位内容。除非本次变更目标就是调整模板占位策略，否则不要把这些占位内容替换成模板仓库自身信息。
TODO：用一段话说明本项目是什么。
本模板维护项目规则、文档结构和通用协作配置。开发环境由各项目自行选择和维护。
修改模板结构或规则后，检查占位内容与文档入口，并运行格式检查：
git status --short --branch
git diff --check
rg -n "TODO|YYYY-MM-DD|@TODO-owner" .
pre-commit run --all-filesTODO 命中应来自模板占位或示例。新增、删除或移动模板文件时，同步检查 README.md、AGENTS.md、docs/README.md 和 docs/conventions.md 中的文档入口。
模板仓库不配置 CI；派生项目按实际需求添加自己的 workflow。
使用本模板创建新项目后，至少完成以下事项：
- 替换
README.md、AGENTS.md、SECURITY.md和文档模板中的项目占位内容。 - 确认项目名称、仓库名、包名与发布目标。
- 根据真实团队更新
.github/CODEOWNERS。 - 确认 MIT 许可证是否适用；不适用时替换
LICENSE并同步 README。 - 补齐开发环境及安装、编译、运行、测试、打包、发布命令。
- 声明产物保存位置、校验方式和发布、部署、回滚入口。
- 补齐架构边界、运行模式、验证模式、硬件/外部服务依赖和残余风险。
- 根据项目需要启用或调整 branch protection、DCO、CI、review 和发布门禁。
- 删除不适用的硬件、生产、供应商、SOP 或文档模板章节。
TODO：写清楚本项目实际使用的命令。
公司不强制统一命令名。每个项目自己的安装、编译、运行、测试、打包、发布方式都在本文件中说明。 派生项目必须把这些命令补成可直接执行的项目真值源，说明运行位置、前置条件，以及是否依赖硬件、外部服务或网络。
- Git
- TODO：所需工具链、SDK、系统依赖及安装方式
- TODO：硬件、签名或外部服务条件
TODO：说明如何准备开发环境、安装依赖，以及如何与 CI 保持一致。
创建新项目时，删除不适用的模式，补齐适用模式的命令、运行位置和前置条件。
| 模式 | 用途 | 运行位置 | 是否需要硬件/外部服务 | 命令入口 |
|---|---|---|---|---|
| 开发 | TODO | TODO：开发环境 | TODO | TODO |
| CI | TODO | TODO：GitHub Actions / GitLab CI / self-hosted runner | TODO | TODO |
| 仿真/模拟器 | TODO：例如 QEMU、浏览器、mock 服务 | TODO：开发环境 / CI | TODO | TODO |
| 无硬件运行 | TODO：验证配置、线程编排或基础流程 | TODO：开发环境 / CI | 否 | TODO |
| 硬件诊断 | TODO：验证设备、总线、传感器或产线夹具 | TODO | 是 | TODO |
| 生产/部署 | TODO：打包、发布、安装、升级、回滚 | TODO：CI / self-hosted runner / 产线环境 | TODO | TODO |
涉及硬件设计、生产、供应商交付物或 SOP 的项目，应在 docs/templates/ 对应模板基础上建立正式文档，并在本节链接。
# TODO# TODO# TODO# TODO# TODO本节必须写清楚产物的生成环境、保存路径、名称和校验方式，以及发布、部署、验收、回滚如何使用同一份产物。
AGENTS.md：人类和 AI agent 的项目规则CONTRIBUTING.md：贡献流程和 PR 要求LICENSE：默认 MIT 许可证，派生项目可按需要替换SECURITY.md：安全漏洞报告流程docs/conventions.md：语言、文档、测试、安全等项目约定docs/git.md：Git 工作流和 commit 规范docs/SAD.md：可选，软件架构文档（Software Architecture Document）docs/SDD.md：可选，软件设计文档（Software Design Document）docs/adr/：架构决策docs/rfcs/：提案docs/specs/：设计文档docs/plans/：实施计划docs/templates/：局部规则、硬件设计、供应商记录、SOP 模板docs/hardware/：可选，硬件设计和验证记录docs/production/：可选，生产、发布、验收、回滚流程docs/suppliers/：可选，供应商和第三方交付物记录docs/sop/：可选，标准作业流程
默认采用 Conventional Commits 风格，subject 中文优先，type/scope 保持英文，例如 feat(api): 支持 OAuth callback。详细规则见 docs/git.md。