引子

最近在项目中使用 GitHub Copilot 的过程中,我发现了一个很有趣的现象。

当我让 Copilot 帮我写代码时,它总是热情满满地给出一大段实现。但当我仔细审视这些代码时,却经常会发现各种小问题——缺少错误处理、异常情况没考虑、命名不规范、没有单元测试,有时甚至会出现一些”魔法数字”。

这让我想起了那些刚入行的程序员,技术不错,但是对软件工程的规范和最佳实践还不够了解。他们写出来的代码能跑,但总让资深工程师皱眉头。

这些 AI 工具确实能提高效率,但如何让它们不仅提高效率,更能精准地产出符合工程实践的高质量代码,甚至达到一种”洗脑”般的效果,让它们乖乖听话,这成了一个值得思考的问题。

不是魔法,是系统指令

经过一段时间的研究和实践,我发现 Copilot 这类 AI 工具实际上可以被深度”引导”,甚至达到一种”洗脑”的效果,让它们按照我们的意愿来行动。

它们并不是魔术盒子,而是遵循一套输入-输出原则的系统。如果我们能给它提供明确的指导和原则,它就能相应地调整自己的输出。

这个思路促使我整理了一个专门用来给 GitHub Copilot”洗脑”的指令集:prompts

这个仓库里不是代码,而是一系列指导 AI 行为的 Markdown 文件。每个文件就像是给 AI 的一份规范或指南,告诉它应该怎样思考和行动。

这套指令能解决什么问题?

使用 AI 编程助手时,我们通常会遇到这些问题:

  • 生成的代码能运行,但结构混乱,难以维护
  • 没有考虑边界情况和异常处理
  • 代码风格不一致,命名随意
  • 缺乏适当的测试覆盖
  • 不遵循项目已有的架构模式

这套指令集就是为了解决这些问题而设计的。它告诉 AI 该如何思考软件设计、如何编写清晰的代码、如何进行测试驱动开发,以及如何分解复杂问题。

指令集的构成

整个指令集分为几个主要部分:

  1. 核心行为定义:这部分告诉 AI 应该如何进行思考和工作,包括:

    • 如何保持项目知识的连贯性(memory-bank)
    • 如何有条理地回应用户(response-and-prompt-guidelines)
    • 如何遵循 TDD 工作流(programming-workflow)
    • 如何分解复杂任务(workflow-and-task-splitting)
  2. 代码质量规范:这部分告诉 AI 什么是好代码,什么是坏代码:

    • 代码标准和最佳实践(code-standards)
    • 代码异味和应避免的反模式(avoid-bad-smells)
    • 如何编写有效的测试(testing-guidelines)
  3. 流程模板:这部分提供了从需求到实现的结构化方法:

    • 如何将模糊的想法转化为明确的计划(req)
    • 如何协助业务分析师编写用户故事(ba)
  4. 工具使用指南:这部分包含了一些高级技巧:

    • 如何使用顺序思考解决问题(sequential-thinking)
    • 快捷指令系统(shortcut-system-instruction)

这些指令是怎么起作用的?

你可能会好奇,为什么一些 Markdown 文件就能让 AI 变得这么听话?

我在研究这些指令的时候发现,它们其实就是几个简单的套路。比如,我给 AI 安排了不同的”角色”——有时候它是个健忘的工程师(所以必须写文档),有时候它是业务分析师的助手。这样一来,AI 就会按照角色来思考问题。

还有一个很有效的技巧是强制它”慢思考”。很多指令都要求 AI 必须一步一步地展示思考过程,不能直接给答案。这就像我们做数学题时要求”列出解题步骤”一样。

最有意思的是”自我批判”这一招。我发现如果让 AI 在给出解决方案后,再强制它自己找毛病,代码质量会提升很多。就像程序员写完代码后再做一遍 code review。

另外,我还设计了一些结构化的模板。比如写测试用例必须按照固定格式,写需求必须一个章节一个章节地来。这样 AI 就没法偷懒,必须把每个环节都考虑到。

说白了,这套指令的核心就是不让 AI “想当然”。它必须按照预设的流程来工作,该问的问题不能跳过,该考虑的边界情况不能遗漏。

如何在实际工作中使用这套指令

经过实践,我发现在 VS Code 中配置 Copilot 使用这些指令非常简单:

  1. 打开 VS Code 设置(Ctrl+, 或 Cmd+,)
  2. 搜索 github.copilot.chat.codeGeneration.instructions
  3. 添加指向指令文件的配置,例如:
1
2
3
4
5
6
7
"github.copilot.chat.codeGeneration.instructions": [
{ "text": "避免生成与公共代码完全匹配的代码" },
{ "file": "../prompts/.github/instructions/req.md" },
{ "file": "../prompts/.github/instructions/ba.md" },
// 其它指令文件...
{ "file": "../prompts/.github/instructions/shortcut-system-instruction.md" }
]
 

需要注意的是,文件路径要正确。这里的路径是相对于你的 workspace 的。如果你的 prompts 仓库和当前项目不在同一位置,可能需要调整路径。

设置完成后,你会发现 Copilot 生成的代码质量明显提升:更规范、更健壮、考虑更周全。

一点思考

给 AI 工具”洗脑”,或者说深度引导它们,其实和带新人有些相似 —— 你需要清晰地表达期望,提供良好的指导和范例,然后持续进行纠正和反馈。

这不是一项精确的科学,而是一个持续改进的过程。不同项目可能需要对指令进行一些定制和调整,以适应特定的技术栈和团队风格。

对我来说,这套指令系统的价值不仅在于提升了 AI 工具的输出质量,更在于它促使我思考:什么是好的代码?什么是好的软件工程实践?这些思考反过来又能帮助我们在日常工作中做得更好。


如果你也在使用 AI 编程助手,不妨试试这套指令。如果有任何想法或改进建议,欢迎到 prompts 仓库提交 PR 或 Issue。

如何给 GitHub Copilot "洗脑”,让 AI 精准遵循指令产出高质量代码的更多相关文章

  1. Github即将破百万的PDF:编写高质量代码改善JAVA程序的151个建议

    在通往"Java技术殿堂"的路上,本书将为你指点迷津!内容全部由Java编码的最佳 实践组成,从语法.程序设计和架构.工具和框架.编码风格和编程思想等五大方面,对 Java程序员遇 ...

  2. 让 AI 为你写代码 - 体验 Github Copilot

    前几天在群里看到有大神分享 Copoilot AI 写代码,看了几个截图有点不敢相信自己的眼睛.今天赶紧自己也来体验一下 Copoilot AI 写代码到底有多神奇. 申请 现在 Copoilot 还 ...

  3. [转帖]熬夜变傻有科学依据,人类睡觉时会被“洗脑”,科学家首次拍下全程 | Science

    熬夜变傻有科学依据,人类睡觉时会被“洗脑”,科学家首次拍下全程 | Science https://mp.weixin.qq.com/s/hJeJjh0GSUclcoh3Z6mySQ 关注前沿科技 量 ...

  4. Github Copilot 结合python的使用

    之前提交的github copilot技术预览版申请,今天收到准入邮件,于是安上试一试这个准备把我送去电子厂上班的copy a lot ? 官网及申请地址:https://copilot.github ...

  5. Github Copilot 比在座各位更会写代码。jpg

    之前大佬和我安利过 Copilot, 作为一个能用就行的践行者, 我一贯对这些东西都不太感兴趣. 就如我多年VS Code写各种编程语言, jetbrains 全家桶我都懒得搞~ 不过最近看到过Cha ...

  6. 什么是老板思维,什么是员工思维,深有体会,最近被N个行业洗脑……

    什么是老板思维,什么是员工思维,深有体会,最近被N个行业洗脑……

  7. 【mp3】洗脑循环了!龙珠超 自在极意功 【究极の圣戦】串田アキラ 背景纯音乐

    自在极意功情况下发动自带bgm 曲名:究极の圣戦 首先是视频: http://dwz.cn/6Tj2Lq 然后是mp3:度盘下载>> 老外翻唱: 个人翻唱:全民k歌>>

  8. 解决:GitHub 远程端添加了 README.md 文件后,本地 push 代码时出现错误

    一.错误描述 To github.com:compassblog/PythonExercise.git ! [rejected] master -> master (fetch first) e ...

  9. (诊断)解决GitHub使用双因子身份认证“Two-Factor Athentication”后无法git push 代码的“fatal: Authentication failed for ...”错误

    在GitHub上采取双因子身份认证后,在git push 的时候将会要求填写用户的用户名和密码,用户名就是用户在GitHub上申请的用户名,但是密码不是普通登录GitHub的密码. 一旦采取双因子身份 ...

  10. 推荐几本高质量的Python书籍--附github下载路径

    一 为什么要分享? 最近碰到了一些人和事,感触挺大的.就是发现很多类似自己的软件工程师,一旦工作三五年之后,工作中算是一个熟练工,但是进步的脚步突然慢了下来,虽然你在工作中仍旧很努力.到底是什么原因呢 ...

随机推荐

  1. 探秘Transformer系列之(16)--- 资源占用

    探秘Transformer系列之(16)--- 资源占用 目录 探秘Transformer系列之(16)--- 资源占用 文章总表 0x00 概述 0x01 背景知识 1.1 数据类型 1.2 进制& ...

  2. 使用LLaMA-Factory训练LLM大模型并用ollama调用

    环境搭建 系统环境 需要Nvidia显卡,至少8G显存,且专用显存与共享显存之和大于20G 建议将非安装版的环境文件都放到非系统盘,方便重装或移植 以Windows11为例,非安装环境文件都放在 E ...

  3. static修饰成员方法、static修饰成员的特点总结、浅聊主方法-java se进阶 day01

    1.工具类的介绍 工具类不是用于描述事物的类,而是帮我们完成事情的类(打工) 如图 当我们编写完这个类后,我们会发现一件事,这个类自己本身并没有意义,这个类完全是给用户进行调用方法的 既然是专门给用户 ...

  4. AI团队比单打独斗强!CrewAI多智能体协作系统开发踩坑全解析

    AI团队比单打独斗强!CrewAI多智能体协作系统开发踩坑全解析 阅读时间: 5分钟 | 字数: 1500+ "你是否曾为单个大模型难以解决复杂专业问题而苦恼?是否想过,如果能像组建专业团队 ...

  5. 使用Python解决Logistic方程

    引言 在数学和计算机科学中,Logistic 方程是描述人口增长.传播过程等现象的一种常见模型.它通常用于表示一种有限资源下的增长过程,比如动物种群.疾病传播等.本文将带领大家通过 Python 实现 ...

  6. Vue横向滚动鼠标控制

    let level_cards // 标记可移动 , move_start // 移动初始的x位置 , move_x // 移动初始的容器偏移量 , move_scroll_left // 判断是否为 ...

  7. Salt之Cpu 100%无响应故障 Salt request timed out. The master is not responding

    报错信息如下: Salt request timed out. The master is not responding. You may need to run your command with ...

  8. QUBO建模

    技术背景 QUBO(Quadratic Unconstrained Binary Optimization)模型是一种常用于求解组合优化问题的一种技术,它所能够求解的问题是这样定义的:给定一个布尔类型 ...

  9. access 类对象使用

    类模块代码如下: Option Explicit '定义按钮对象和onclick 触发内容 Private WithEvents m_Closebtn As Access.CommandButton ...

  10. Asp.net core 少走弯路系列教程(六)C# 语法学习

    前言 新人学习成本很高,网络上太多的名词和框架,全部学习会浪费大量的时间和精力. 新手缺乏学习内容的辨别能力,本系列文章为新手过滤掉不适合的学习内容(比如多线程等等),让新手少走弯路直通罗马. 作者认 ...