ios-mcp AGENTS.md

AGENTS.md

本文件用于约束 Codex 在本仓库中的 Git 操作、提交日志生成、版本发布流程。

本项目是一个在 GitHub 上维护的开源项目，日常开发场景主要包括：

• 优化已有功能
• 修复 bug
• 新增功能
• 更新文档
• 发布新版本

Codex 在执行 Git 相关操作时，必须严格遵守本文件中的规范。

---

一、AGENTS.md 使用规则

1. 文件命名规则

如果希望 Codex 自动读取项目规则，文件名应使用：

AGENTS.md

不要将本文件改名为：

GIT.md
SKILL.md
AGENT.md
agents.md

如果项目中已经存在 AGENTS.md，不要新建第二个同名文件，也不要直接覆盖原文件。应该把本文件中的 Git 规范、提交流程、发布流程合并到已有 AGENTS.md 中。

2. 多个 AGENTS.md 的处理方式

如果仓库里已经有其他 AGENTS.md，优先按以下方式处理：

1. 根目录已有 AGENTS.md：把本文件内容合并进去，建议放在 Git 工作流规范 章节。
2. 子目录已有 AGENTS.md：子目录规则只用于该子目录相关任务，根目录仍应保留全局 Git 规范。
3. 如果已有 AGENTS.md 中的规则和本文件冲突，以更具体的规则为准；如果都是全局规则，以用户最新明确要求为准。
4. 不要因为新增 Git 规范而删除已有项目规则、构建规则、测试规则或代码风格规则。

3. 推荐组织方式

推荐在根目录 AGENTS.md 中使用以下结构：

# AGENTS.md

## 项目说明
## 开发规范
## 测试规范
## Git 工作流规范
## 发布流程规范

本文件主要提供：

Git 工作流规范
发布流程规范

---

二、基础原则

1. 所有关键操作必须经过用户确认

以下内容必须先展示给用户，并等待用户明确确认后才能继续执行：

• commit 提交日志
• git add
• git commit
• git push
• release 分支创建或切换
• tag 创建
• GitHub Release 标题
• GitHub Release 内容
• GitHub Release 创建
• 合并 release 分支到 main

用户没有明确确认之前，不允许直接执行提交、推送、打 tag、创建 GitHub Release。

2. 禁止危险操作

除非用户明确要求，否则禁止执行以下命令：

git reset --hard
git push --force
git clean -fd
git branch -D
git push origin --delete

尤其注意：发布完成后不要删除 release 分支。

---

三、分支命名规范

1. 分支命名格式

分支名称统一使用：

类型-简短描述

类型和描述之间使用 - 分隔，不使用 /。

2. 常用分支类型

feature-xxx     新功能开发
fix-xxx         普通问题修复
hotfix-xxx      紧急问题修复
release-x.x.x   版本发布分支
docs-xxx        文档修改
refactor-xxx    代码重构
chore-xxx       构建、配置、依赖等调整
perf-xxx        性能优化

3. 分支命名示例

推荐：

feature-ui-query
feature-screenshot-api
fix-click-position
fix-rootless-install
hotfix-launch-crash
release-1.1.0
docs-update-readme
refactor-element-parser
chore-update-makefile
perf-optimize-screenshot

不推荐：

feature/ui-query
release/v1.1.0
release-v1.1.0
fix_click_position
Feature-Login
我的分支
update

4. main 分支规则

main 分支代表当前最新稳定版本。

发布完成后，release 分支必须合并回 main，保证 main 始终对应最新正式发布版本。