我正在使用Laravel制作一个自定义应用程序。默认情况下,Laravel生成一个composer.json文件,如下所示:
{
"name": "laravel/laravel",
"description": "The Laravel Framework.",
"keywords": ["framework", "laravel"],
"license": "MIT",
}
更改我项目的名称、描述、许可证等是否是一种好的做法?
更多信息:我正在为另一家公司开发这个项目。他们将在内部使用它(作为一个公共网站),未来可能会也可能不会雇佣不同的开发人员。
老实说,除非您计划将项目发布为允许人们运行composer create-project you/yourproject
的composer项目,否则更改它不会带来真正的好处。
如果你计划只在内部进行更改,没有真正的规则,但有两个论点,一个支持,一个反对。
- 更改它可以使它变得简单,并为项目开发人员提供一些基本信息的一个很好的小来源
- 将其保留为默认值允许您和其他开发人员访问有关系统创建的一些基本信息
所以最终,这完全取决于你。
是的,您应该编辑它以反映当前状态。至少删除你不想要的信息,比如MIT许可证(你可能不想以这种方式许可专有代码)、关键词、描述和名称。
也许在未来,composer create-project
会更正确地处理它(源项目需要有一个可识别的名称,但创建项目几乎不需要保留这个名称),但这对现有项目也没有帮助。
保持元数据的正确性(至少删除不正确的数据)-你永远不会知道它的好处。就我个人而言,我非常喜欢有正确的项目名称,因为这个名称在我的Satis页面上显示为"使用此包的项目",即反向依赖项,所以我知道如果我更改库,该更新什么。