PAYATHON 2026

如何让 GitHub Copilot CLI 编写 Blazor 代码时始终使用 MudBlazor?

架构老王

推荐使用持久化自定义指令

对于“编写 C# Blazor 界面时使用 MudBlazor”这样的长期约定,可以使用 custom instructions。项目要求可以写入仓库根目录下的 .github/copilot-instructions.md;跨仓库的个人偏好可以写入 ~/.copilot/copilot-instructions.md。当前 GitHub Copilot CLI 支持这两个位置。官方配置说明

自定义指令可以省去反复提醒,但模型仍可能偏离规则,生成后需要检查。自定义机制说明

在仓库中写明 MudBlazor 约定

在仓库根目录创建 .github/copilot-instructions.md。如果文件已经存在,就把新要求合并进去,并保留已有的项目约定。文件使用普通 Markdown,无需额外的配置语法。仓库级指令说明

可以参考下面的指令,并根据项目需要调整:

# Blazor UI conventions

- When creating or modifying C# Blazor UI, use MudBlazor components
  wherever they provide the required functionality.
- Do not introduce another UI component library without explicit approval.
- Follow the repository's existing MudBlazor component patterns,
  theme, and layout conventions.
- Before using a MudBlazor API, check the package version referenced
  by the project and verify that the API is available in that version.
- If MudBlazor is not installed or configured, explain the required
  setup before proposing dependency or startup changes.
- If a requirement cannot be implemented with MudBlazor components,
  explain the limitation before proposing an alternative.

示例将“使用 MudBlazor”限定在界面开发中,业务逻辑、数据访问等普通 C# 代码无需因此依赖 UI 组件库。它也说明了缺少依赖、API 不兼容或组件无法满足需求时的处理方式,避免模型为了满足“始终使用”而编造实现。

如果希望团队共享这项约定,可以将该文件提交到版本控制。

多个项目都要使用时如何配置?

如果这是你的个人偏好,可以将同样的条件式要求放入:

~/.copilot/copilot-instructions.md

保留“When creating or modifying C# Blazor UI”这一适用条件,以免影响其他类型的项目。如果设置了 COPILOT_HOME,用户级指令的位置会随之改变。多个适用的指令文件会一起提供给 Copilot。官方没有规定这些文件之间通用的优先顺序,因此应避免个人要求与仓库约定互相冲突。用户级指令与合并规则

prompt、skill 和 agent 分别适合什么?

方式 适合的用途
prompt 指定当前任务,例如要求这次新增的表单使用 MudBlazor。
custom instructions 保存长期约定,例如仓库中的 Blazor 界面统一使用 MudBlazor。
skill 封装重复执行的流程,例如按照固定步骤迁移表单并验证结果。
custom agent 定义专门的角色及工具范围,例如负责 Blazor 界面开发或审查的助手。

GitHub 将 custom instructions 用于持续性的行为指导,将 skill 用于特定任务的流程和资源,将 custom agent 用于定义专门角色。对于这个问题,先写一份简短的自定义指令就够了;以后出现复杂的页面生成或迁移流程,再考虑增加 skill。官方机制对比

如何确认配置生效?

修改指令文件后,启动新会话,或退出当前会话后通过 copilot --continue 恢复。根据当前文档,指令文件的修改不会立即应用到正在运行的会话。随后在交互界面运行:

/instructions

检查目标文件是否被发现并启用。会话加载与检查说明

接着可以提出一个小任务,例如“新增一个包含姓名输入框和提交按钮的 Blazor 表单”,检查生成结果是否使用 MudBlazor,以及所用 API 是否符合项目中的依赖版本。指令被加载只能证明配置进入了会话,代码是否正确仍需通过审查、构建和实际运行确认。

备注:内容仅供参考。