| | |
|---|
| | | # Apptag Project Rules |
|---|
| | | 本项目 Hermes 必须严格遵守的规则 |
|---|
| | | |
|---|
| | | ## Checkpoint workflow |
|---|
| | | ## 版本管理 & 需求记录铁律（每次任务都必须执行） |
|---|
| | | 1. 任何修改文件前，必须先执行 checkpoint： |
|---|
| | | git add -A && git commit -m "checkpoint: [本次任务简要描述]" |
|---|
| | | |
|---|
| | | 每次开始任务前：`git status` 检查当前状态。 |
|---|
| | | 2. 任务完成后，**必须**更新 DECISIONS.md： |
|---|
| | | - 在文件最顶部追加一节新内容（使用当前日期） |
|---|
| | | - 格式必须严格遵守下面的模板 |
|---|
| | | |
|---|
| | | 每次完成一个独立的功能或修复后，做一次 checkpoint commit： |
|---|
| | | 3. 最后执行正式 commit： |
|---|
| | | git add DECISIONS.md .hermes.md && git commit -m "docs: 更新 DECISIONS.md [任务描述]" |
|---|
| | | |
|---|
| | | 4. 如果是重大功能，自动推送 GitHub PR（可选） |
|---|
| | | |
|---|
| | | ## DECISIONS.md 记录模板（必须完全按照这个格式） |
|---|
| | | |
|---|
| | | ``` |
|---|
| | | git add -A && git commit -m "checkpoint: <简短描述>" |
|---|
| | | ## [YYYY-MM-DD] 任务标题 |
|---|
| | | **需求来源**：（你当时说的原话或简要描述） |
|---|
| | | **决策理由**：（为什么这么实现，有什么取舍） |
|---|
| | | **实现内容**：（做了哪些改动） |
|---|
| | | **影响文件**：（列出修改的文件） |
|---|
| | | **回滚命令**：git revert <本次commit-hash> 或 git checkout <上一个checkpoint> |
|---|
| | | **测试命令**：（如果有） |
|---|
| | | ``` |
|---|
| | | |
|---|
| | | 任何时候用户可以喊：**"rollback to last checkpoint"** — 执行 `git reset --hard HEAD~1` 回滚到上一个 commit。 |
|---|
| | | 此文件由 Hermes 自动维护，请勿手动删除历史记录。 |
|---|
| | | |
|---|
| | | ## 恢复已删除的 checkpoint |
|---|
| | | |
|---|
| | | 如果用户后悔回滚了，可以用 `git reflog` 找回被丢弃的 commit，然后 `git reset --hard <hash>` 恢复。 |
|---|
