javascript - 在github上面发布repo需要注意什么？

Question

第一次发布github项目，点击这里

我看到有个项目的目录是这样的

但我的是这样的

请问：
1.它的项目为什么没有node_modules，不需要吗？
2.makefile、travis.yml那些文件有必要吗？
3.文件、文件夹命名有什么规范吗？
4.如果我不发布到npm上，而直接作为模块放到node_modules下，是否存在问题？
5.命名为baidu-ocr-idcard是否侵权？

还有其他什么需要注意的吗？感谢。

Answer 1

1. 因为 node_modules 是安装的时候生成的。自动生成的文件一般不加入仓库。在你的全局 gitignore 文件中过滤掉它吧。
2. 如果你使用 make 构建你的项目那么会需要 Makefile。如果你使用 travis.ci 的 CI 服务那么需要注册并添加 travis.yml 文件。
3. 有很多文件名是有惯例的。
4. 我不了解 npm。不过那样别人能够方便地使用吗？
5. 不要把包含密码等信息的文件提交到仓库中
6. 不要提交巨大又没用的压缩包和自动生成的文件。

Answer 2

只要是能够自动生成的文件，或者有个体差异的，都不要提交上去