怎么说呢,感觉学习编程好几年了,对于Github这个一直是处于了解,而不去使用的状态,想了想大概是对于新的东西抱着不想费力去学习的想法和懒得看英文这两种态度把。2020年秋招的时候,找到了一份还算不错的工作,但是要从java转到Go,最近这几个月也是看了看几本关于Go的书籍,但是总觉得是没有项目或者说实战的话,掌握还是不牢靠的,找着找着最后还是觉得Github需要拿来学习学习了。
第一就是清楚一下上边的结构
build/ 构建脚本
dist/ 编译出来的发布版
docs/ 文档
examples/ 示例文件(如果你写的是库的话)
src/ 源码
test/ 测试脚本
.babelrc Babel 交叉编译的配置
.eslintrc ESLint 测试配置
.gitignore 哪些文件不要上传到 GitHub
.gitattributes 文件属性,如 EOL、是否为二进制等LICENSE 授权协议README.md 自述文件,里面至少得写:
项目的特色
各种 Badge 比如 CI 的
怎么下载安装
示例运行/使用
怎么编译(尤其 C/C++,要把编译器、要装什么工具、依赖库全部写清楚。要带版本号!)
怎么参与
circle.yml Circle CI 持续集成配置文件(当然你可能用别的 CI,名字会变。比如我那个 otfcc 使用了两个 CI:Travis 和 Appveyor,就写了两个配置)
bower.json Bower 包管理器配置文件
package.json npm 包管理器配置文件
以上内容均为转载
作者:Belleve(来源知乎)
链接:https://www.zhihu.com/question/48019650/answer/109951418
但是我感觉很多项目并不是完全按照以上的结构来写的,是这个介绍太简单了还是没有作者随心所欲了一把?不知道等我再去好好钻研一下。