在github新建一个项目里需要哪些文件及作用
Posted 红鲤鱼与LV
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了在github新建一个项目里需要哪些文件及作用相关的知识,希望对你有一定的参考价值。
1.README.md文件
关于项目的介绍和使用方法。
2. .gitignore文件
上传项目时不需要传的文件,最常用的就是“node_modules/",如下:
详细的介绍可以去git官网上看:https://git-scm.com/docs/gitignore
规则总结如下: 匹配模式前 / 代表项目根目录 匹配模式最后加 / 代表是目录 匹配模式前加 ! 代表取反 *代表任意个字符 ?匹配任意一个字符 **匹配多级目录
3. 。npmignore文件
项目如果要发到npm上共别人使用,像src、test都不需要发,npm上需要bulid(或者是dist,即node打包构建出来的东西,像scr这种源码,不能执行,不用上传到npm上,test这种单元测试的也不需要)
文档:https://docs.npmjs.com/misc/developers
4. .editoreconfig 设置本项目代码书写的风格(比如空格是空2个还是4个呀,。。。)
文档:https://editorconfig.org
以上是关于在github新建一个项目里需要哪些文件及作用的主要内容,如果未能解决你的问题,请参考以下文章