create-copilot-instructions

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Create Copilot Instructions

创建Copilot指令

Create or update

AGENTS.md

file for the project.

为项目创建或更新

AGENTS.md

文件。

Steps

步骤

Review the documentation at https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot to understand what constitutes a well-crafted
```
AGENTS.md
```
or
```
copilot-instructions.md
```
.
Conduct a thorough examination of the codebase to understand the architecture and stylistic conventions.
Check if
```
AGENTS.md
```
or
```
.github/copilot-instructions.md
```
already exists.
```
.github/copilot-instructions.md
```
takes precedence over
```
AGENTS.md
```
. If found, analyze its contents to extract pertinent information for the new file.
Compose a
```
AGENTS.md
```
document including:
- A concise summary of the project's objectives and functionalities.
- A clear delineation of coding style and formatting standards.
- Guidance on usage of any unconventional libraries, frameworks, or tools.
- Project-specific conventions, constraints, or nuanced considerations.
- The designated language for in-code annotations and commentary.
Create or rewrite the
```
AGENTS.md
```
file within the project directory, ensuring that it is accurately named and appropriately situated.

You are expected to respond only after deliberate and methodical contemplation, as this inquiry places a premium on accuracy. To enhance the quality of your response, you are hereby granted the latitude to employ additional cognitive resources for deeper reflection.

Let's do this step by step.

查阅https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot文档，了解如何撰写优质的`AGENTS.md`或`copilot-instructions.md`文件。
全面检查代码库，了解项目架构和风格规范。
检查项目中是否已存在
```
AGENTS.md
```
或
```
.github/copilot-instructions.md
```
文件。
```
.github/copilot-instructions.md
```
的优先级高于
```
AGENTS.md
```
。如果找到现有文件，分析其内容以提取可用于新文件的相关信息。
撰写
```
AGENTS.md
```
文档，内容应包括：
- 项目目标与功能的简要概述。
- 明确的编码风格与格式标准。
- 非常规库、框架或工具的使用指南。
- 项目专属的规范、约束或细节考量。
- 代码注释与说明的指定语言。
在项目目录中创建或重写
```
AGENTS.md
```
文件，确保文件名准确且存放位置恰当。

请你经过深思熟虑后再做出回应，因为此任务对准确性要求极高。为提升回应质量，允许你调用更多认知资源进行深度思考。

让我们一步步来完成。