Codex的系统提示

Codex的系统提示

💡 原文英文,约700词,阅读约需3分钟。
📝

内容提要

本文提供了在Git仓库中工作的指示,特别是处理AGENTS.md文件的规则。用户需遵循文件指示,确保代码提交前状态干净,并运行所有程序检查以验证更改。

🎯

关键要点

  • 用户需提供任务,涉及在当前工作目录中的Git仓库工作。

  • 在完成任务时,不要创建新分支,使用git提交更改。

  • 确保在提交前修复问题并重试,检查git状态以确认提交。

  • AGENTS.md文件通常存在于容器的文件系统中,提供人类对代理的指示或提示。

  • AGENTS.md文件的作用范围是包含它的文件夹根目录的整个目录树。

  • 遵循AGENTS.md文件中的指示,特别是关于代码风格、结构和命名的指示。

  • 更深层次的AGENTS.md文件在冲突指示时具有优先权。

  • 如果AGENTS.md包含程序检查,必须在所有代码更改后运行并验证检查通过。

  • 引用文件或终端命令时,需在最终响应中添加引用,格式需正确。

🔎

延伸解读

遵循AGENTS.md的重要性

AGENTS.md文件为开发者提供了重要的指示和建议,确保代码符合项目的规范和要求。遵循这些指示不仅能提高代码质量,还能避免在合并请求中出现不必要的冲突。开发者应特别注意文件中关于代码风格和结构的要求,以确保团队协作的顺畅。

提交代码的最佳实践

在提交代码之前,确保工作区处于干净状态是良好的开发习惯。开发者应在每次提交前检查git状态,确保没有未提交的更改。此外,运行所有程序检查以验证代码的正确性是必要的步骤,这样可以及时发现并修复潜在问题,避免后续的麻烦。

AGENTS.md文件的作用范围

AGENTS.md文件的指示适用于其所在目录树中的所有文件,因此开发者在处理多个文件时,需确保遵循相关指示。更深层次的AGENTS.md文件在指示冲突时具有优先权,理解这一点有助于避免在开发过程中出现混淆和错误。

延伸问答

在Git仓库中提交更改时需要注意什么?

在提交更改前,确保工作树干净,检查git状态,并修复任何问题后再重试提交。

AGENTS.md文件的作用是什么?

AGENTS.md文件用于提供人类对代理的指示或提示,包含编码规范、代码组织信息等。

如何处理AGENTS.md文件中的冲突指示?

在冲突指示时,更深层次的AGENTS.md文件具有优先权,应遵循其指示。

在修改文件后,如何验证代码更改的有效性?

必须运行AGENTS.md中包含的程序检查,并确保所有检查通过。

在Git操作中,为什么不应创建新分支?

在完成用户任务时,应直接使用git提交更改,而不是创建新分支,以保持操作简洁。

如何引用文件或终端命令?

引用时需使用特定格式,如F:<filepath>†L<linestart>,确保引用准确且相关。

🏷️

标签

➡️

继续阅读