什么依赖文件?

时间:2016-12-13 22:03:33

标签: documentation dependency-management

为了清楚起见,我不是在README.md中询问how to add dependencies,而是根据我的情况如何处理它们。

看看SO Help Center,我认为这是一个实用的,可回答的问题,这是软件开发所特有的,"我认为在这里提问是合适的。

我需要一些关于项目的指导。总结一下......该项目是小型企业的技术原型,我打电话给#34; ACME,&#34 ;与我签约,并使用Raspberry Pis作为分布式客户网络为其客户提供服务。 ACME的所有者不是技术人员。他强调了项目的简洁性,可扩展性和稳定性,我希望避免不必要的混淆。

我担心的是,虽然我的直接依赖很少,大概有两三个,但我的子依赖很多。 (为了澄清,我在Node.js中对项目进行了编码,除了一些小的C ++工作程序。)我使用的模块共有大约40个或更多的子依赖项。

对我来说最重要的是做正确的事情,特别是这是我作为开发人员的第一份正式工作,而且我自己都没有高级开发人员提供建议。

所以...我应该只列出我的直接依赖项(我更喜欢哪些,以及哪些处理文件记录它们的依赖项),或列出所有依赖项?

1 个答案:

答案 0 :(得分:1)

npm可以自行列出您的依赖项(npm ls)。您需要记录的是如何使系统启动和运行,无论是作为用户还是作为开发人员(您的继任者或将来需要从头开始恢复您的开发设置时)。

编辑:此外,您还需要记录自己的程序如何作为整个系统中的组件组合在一起。