一个良好的项目目录结构

e00f05baedca2dfade3a181596d958b1_b.png

build/ 构建脚本
dist/ 编译出来的发布版
docs/ 文档
examples/ 示例文件(如果你写的是库的话)
src/ 源码
test/ 测试脚本
.babelrc Babel 交叉编译的配置
.eslintrc ESLint 测试配置
**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来源:知乎著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

1.有文档说明2.有开源协议著名并遵守其要求3.写好每次commit的说明注释4.有人看着issue和pr,别完全不鸟5.代码格式、命名什么的遵循一定规范6.对于在线项目尽可能提供点儿例子7.有稳定版本请提供release

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,099评论 19 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,960评论 25 709
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,267评论 4 61
  • 洪若虚倒是第一次碰见有这么对付自己的,想一想自己这招逃避讲课的法子屡试不爽,还从来没有失手过,今天也不能就这么认...
    红色的以太阅读 264评论 0 1
  • 这是一个火热的年代,这是一个火热的城市,到处都听得到创业的铁锹敲打年轻的心;到处都是精神上和概念上的大吊车在梦想的...
    回声鸟阅读 1,096评论 0 6