跳到主要内容
Agent 实践室CODEX STUDY CLUB
返回学习路线
查看全部 14 篇教程 当前第 11 章
开发者入门第 11 章 / 共 14 章

CLI 第一个任务:只读了解、小步修改、逐项验收

以 README 的一处修改练习 Codex CLI,检查文件差异和项目验证,只提交确认过的本次文件。

内容核对

先完成安装与登录,再选一个自己有权修改的 Git 仓库。这次只补清楚 README 中的一条操作步骤;不同时升级依赖、重构代码或发布产品。

1. 看清起点

在仓库目录中运行:

git status --short
git diff --stat
git diff --cached --stat

记下已有的已暂存、未暂存和未跟踪文件。若里面有你不理解的改动,先换到干净的练习分支或独立练习仓库,不清空现有工作。

启动 codex,先要求它解释:

阅读 AGENTS.md、README.md 和项目定义的检查命令。
只读分析:找一处新手无法判断是否操作成功的说明,指出文件位置,
解释缺少的前提或验收方法,并提出只修改 README.md 的方案。
不要安装依赖、修改文件、提交或发布;没有依据的命令不要猜。

检查引用的文件与命令。若没有找到真实问题,就结束这次分析或选择另一个问题,不必为了练习制造无意义改动。

2. 只执行确认的一处修改

选定问题后再继续:

按刚才确认的问题修改 README.md,只补充必要的前提、步骤和验收方法。
保留原有链接与无关内容,不修改其他文件,不提交、不推送、不部署。
遵守当前仓库要求的检查;先说明命令,再运行允许且适用的检查。
完成后列出改动、实际执行的验证与尚未验证的部分。

如果项目要求更新生成内容或运行构建,而这会超出文件范围,先明确扩展范围,再继续。不要让“只改 README”的表述成为跳过项目约定的理由。

3. 自己检查完整差异

git status --short
git diff --check
git diff -- README.md
git diff --cached -- README.md

普通 git diff 不会显示未跟踪文件的正文;状态列表里出现意外文件时,另外打开检查。对照起点,确认没有混入别人的改动。验收至少包括:

检查项 可接受的结果
范围 只有已确认的文件与段落发生变化
依据 命令、路径和链接来自当前项目或实际核对的原文
可读性 打开 Markdown 预览,代码块、列表和链接能正常阅读
项目检查 按仓库约定运行并记录结果,失败项未被省略
实际效果 步骤经过执行才写成实测;没有执行就保留待验证状态

本仓库的内容贡献还需运行 Lint、构建并检查生成文件,具体见内容贡献练习。

4. 只提交审查过的文件

如果这次确实只改了 README,且你确认要保存提交,可以执行:

git add -- README.md
git diff --cached --stat
git diff --cached
git commit -m "docs: clarify README verification steps"

提交前查看的是全部暂存差异。如果有原来已暂存的其他工作,不要直接运行最后一行;先与对应工作负责人确认提交边界。实际涉及其他文件时,逐个确认并明确列出路径,不用全仓暂存代替审查。

最后记下:解决了什么、提交了哪些文件、验证结果、未完成事项。提交仍在本地;需要贡献时走项目的 Fork/PR 流程,推送、合并和上线都要分别核验。

下一章继续查看CLI 选项与命令。

本文基于 CodexGuide 的 MIT 授权内容收录,原作者 canghe。