View on GitHub

wtf-is-a-minimum-reproduction

A Description of what the hell a minim reproduction really is

什么是 TMD 最小复现

最小复现仓库是一个公开共享的 Git 仓库(不公开私有业务逻辑),显示您遇到的问题,并且安装尽可能少的依赖项。它还具有有关如何重现你遇到错误的步骤。它最容易添加到 README 文件中,但老实说你可以在任何地方添加它,甚至是文本文件。

不公开业务逻辑

听起来很简单,对吧?如果错误有关业务逻辑中的特定步骤,请以不明确展示当前工作内容的方式复制业务逻辑。

显示你遇到的问题

这还需要解释?这就是为什么首先应该创建最小复现的原因,因为你有一个希望被人调查的错误。

尽可能安装最少的依赖项

如果复现不需要一个依赖,移除它。数据库通常很容易在最小复现中删除。说真的,你越少让别人启动数据库,其他人就越容易运行它。如果你最终遇到与数据库相关的问题或多个服务器之间的问题,添加 docker-compose.yml 文件来协调连接会有很大帮助。

复现步骤

有关如何复现错误的一组清晰、明了的步骤。如果你需要,你也可以将设置和复制步骤分开。下面是一个例子:

# 设置
1) npm install

# 复现

1) npm run start:dev
2) 打开新的终端
3) curl http://localhost:3000/users
4) 查看错误

好,我已明白它是什么,我还需要什么?

一般来说,满足上述条件就足够了。这有助于那些调试错误并提供巨大支持的人。

为什么我被要求这样做呢?

提供最小复现有几个原因:

  1. 它使调试错误更加容易。查看 1 个目录中的 2 个文件相比于 5 个目录中的 20 个文件要需要更少的深入和理解。
  2. 在创建最小复现的同时,有一半的可能你将自己发现问题所在,并成长为开发人员和知识共享者。