Github Copilot 备忘清单

需要先拥有一个Github账号，并订阅Copilot。

• Youtube GitHub Copilot 系列
• 实用技巧：充分利用 GitHub Copilot
• 我如何使用 GitHub Copilot 构建浏览器扩展

Copilot会查看编辑器中当前和紧邻打开的文件，以分析上下文并提供适当的建议。

• 1、避免打开过多的文件，以便Copilot能够更好地理解你的代码。
• 2、打开的文件尽量相关且有共性。
• 3、如果是新项目，可以打开一些模版代码、数据文件以及参考文档等相关示例文件。以便Copilot能够更好地理解你的期望。等已经开发了一些代码后，这些示例文件就可以删除了。

创建一个新文件时，在文件顶部添加注释，描述你的需求。这对 Copilot 很有帮助。

* 下面说明将使用...表示copilot开始生成的位置

# Download file from an URL and analyze its content
# Details: 
# * Download the file from an URL
# * Save the downloaded files into `./download` folder
# * Use `filetype` of the file to specify how to parse
# * Filetype can be `.pdf`, `.html`, `.epub`, `.md` and `.txt`
# * Use NLP or OCR to get the file content
# * Tokenize the file content and get the statistics result

import  ...

在每个函数上面或重要代码块的上面添加注释，以帮助 Copilot 了解你代码中的一些意图或问题。

* 下面说明将使用...表示copilot开始生成的位置

函数上方添加注释说明

# parse the JSON string into User object
def ...

代码添加注释说明

# ...
api_sever = FastApi(...)

# starting the API Sever, enable ssl, bind to 8443 port
...

如果你不想切换到 copilot chat 时，注释也可以用于提问。

# Q: What is the difference between `os.path.join` and `pathlib.PurePath`?
# A: ...

你也可以让 copilot 为你生成 todo 列表来评估工作量。

# Parse the json file into a Talks object
# TODO:
# -[ ] 1. ...

提供片段代码示例，以帮助 Copilot 更好地开始新的开发任务。

• 使用的框架与库
• 代码风格
• 算法逻辑

from typing import List
from typing import Optional
from sqlalchemy import ForeignKey
from sqlalchemy import String
from sqlalchemy.orm import DeclarativeBase
from sqlalchemy.orm import Mapped
from sqlalchemy.orm import mapped_column
from sqlalchemy.orm import relationship

class Base(DeclarativeBase):
    pass

class User(Base):
    __tablename__ = "user_account"
    id: Mapped[int] = mapped_column(primary_key=True)
    name: Mapped[str] = mapped_column(String(30))
    fullname: Mapped[Optional[str]]
    addresses: Mapped[List["Address"]] = relationship(
        back_populates="user", cascade="all, delete-orphan"
    )
    def __repr__(self) -> str:
        return f"User(id={self.id!r}, name={self.name!r}, fullname={self.fullname!r})"

# Email Address
...

提供片段数据示例，以帮助 Copilot 更好地开始新的开发任务。

• 数据结构与类型
• 命名
• 值处理逻辑

dailogs = [
    {
        "timestamp": "May 1, 2023 11:00:00",
        "text": "Hello, World!",
        "speaker": "Jack",
    },
    {
        "timestamp": "May 1, 2023 11:01:00",
        "text": "Hello, Copilot!",
        "speaker": "Copilot",
    },
]

# Parse the json object into `Dialog` object
...

仅在/terminal命令中可用

// settings.json
{   
    // ...
    "github.copilot.chat.welcomeMessage": "always",
    "github.copilot.chat.localeOverride": "zh-CN",
    "github.copilot.editor.enableCodeActions": true,
    "github.copilot.editor.iterativeFixing": true,
    "github.copilot.editor.enableAutoCompletions": true,
    "github.copilot.enable": {
        "plaintext": false,
        "ini": false,
        "markdown": true,
        "*": true
    },
    "github.copilot.advanced": {
        "length": 4000,
        "inlineSuggestCount": 5,
        "top_p": 1,
        "temperature": "0.8",
        "listCount": 10,
        "stops": {
            "*": [
                "\n\n\n"
            ],
            "python": [
                "\ndef ",
                "\nclass ",
                "\nif ",
                "\n\n#"
            ]
        },
        "debug.showScores": true,
        "indentationMode": {
            "python": false,
            "javascript": false,
            "javascriptreact": false,
            "jsx": false,
            "typescript": false,
            "typescriptreact": false,
            "go": false,
            "ruby": false,
            "*": true
        }
    }
    // ...
}