跳转到内容

依赖与环境边界

  • 区分本地依赖与全局依赖,并知道各自的坑
  • 在 README 里记录 Node、包管理器等最低版本
  • 用 .gitignore 挡住 node_modules、缓存、密钥与环境变量

学生项目最容易踩的坑不是“代码太难”,而是“环境不稳定”。建议从这些边界入手:

  • 区分本地依赖与全局依赖
  • 记录 Node、包管理器、Python 或 IDE 的最低版本
  • 不要把 node_modules、本地缓存、密钥和环境变量提交进仓库

一个最小可用原则是:别人拿到你的仓库后,只需要两三条命令,就应该能拿到和你一致的结果。比如:

Terminal window
git clone <仓库地址>
npm install
npm run dev

写进 .gitignore 的典型条目:

node_modules/
.env

其中 .env 里的密钥和环境变量一旦提交,就可能泄露到公开仓库;node_modules 不仅体积大,还会让依赖“隐式生效”。

先自己回答,再看答案:

  1. 为什么 .env 不应该提交进仓库?
  2. README 里为什么要记录 Node 或 Python 的最低版本?
  3. 复现项目失败时,问题通常出在哪里?
参考答案
  1. .env 含密钥和环境变量,提交可能造成泄露,也破坏了环境一致性。
  2. 版本不匹配是最常见的“在我机器上能跑”原因,写明最低版本可减少返工。
  3. 往往不是代码本身,而是依赖、版本或环境说明不够清楚。
  • 依赖分本地与全局,记录最低版本而不是口头约定
  • node_modules、缓存、密钥与环境变量一律不进仓库
  • 复现标准:两三条命令得到一致结果
环境边界小测
x
1 / 3

下列哪一项不应该被提交进仓库?