《科研 :VS Code + Codex + GitHub 标准工作流规范》
前提条件:
- 已有 ChatGPT Plus 账号
- 已在 VS Code 安装并登录 Codex 插件(在vscode扩展中下载登录即可)
- 已正确启用 Git 环境,并可访问 GitHub 仓库
1️⃣ 在 VS Code 中如何使用 Codex
📍 1.1 打开目标项目(根目录)
Codex 插件只能作用于 当前打开的项目目录 / 工作区(Workspace)。
🧠 1.2 使用自然语言驱动的代码生成
在 Codex 扩展面板中输入自然语言指令
例如:
1 | 请在 src/utils.py 中添加 compute_accuracy 函数 |
这些自然语言指令会让 Codex 生成/修改相应文件内容,类似 IDE 内智能编辑。
📌 1.3 实际建议与互动
- 在写指令时明确指出目标文件位置
- 检查 Codex 的生成结果,在你保存之前都是“建议”,保存后才是真实写入项目
- 你也可以依赖 Codex 生成单元测试、文档注释、逻辑解释等辅助内容
2️⃣ 使用 Codex 编辑后如何上传到 GitHub
VS Code 与 Git 的集成可以直接处理从 Codex 修改后的代码提交与推送。
🔹 2.1 确认本地是 Git 仓库
打开终端或 VS Code Source Control 面板检查:
1 | git status |
如果尚未初始化:
1 | git init |
🔹 2.2 关联 GitHub 远程仓库
若尚未关联:
1 | git remote add origin https://github.com/你的用户名/仓库名.git |
或通过 VS Code 的命令面板执行 Git: Add Remote。
📌 2.3 提交修改
在 VS Code 左侧 Source Control 面板:
- 查看 Codex 修改后的所有文件
- 点击 +(Stage) 把文件加入暂存区
- 在下方填写清晰的提交信息
- 点击 ✔️Commit 提交
或者在终端:
1 | git add . |
📤 2.4 推送到 GitHub
推送到远程:
1 | git push origin main |
如果当前分支还未与远程关联:
1 | git push --set-upstream origin main |
📌 2.5 通过 VS Code 一键 Publish
首次推送时,VS Code 底部状态栏会出现:
1 | Publish Branch |
点击即可自动推送到 GitHub,无需终端命令。
🧾 工作流程总结(简明版)
1 | 1. 打开 VS Code 并加载项目目录 |
📌 关键注意事项
✅ Codex 只对当前打开的工作区生效
✅ 保存文件前 Codex 只是在“建议”,保存后才写入
✅ Git push 会把所有本地提交推送到 GitHub
✅ 如果你从未关联 remote,先用 git remote add 绑定仓库