github上的文档结构学习
来源:互联网 发布:淘宝发布的宝贝不见了 编辑:程序博客网 时间:2024/06/06 15:38
开源项目目录规范
此为前端开发团队遵循和约定的开源项目目录规范,意在实现开源项目目录结构的一致性。
说明
文档中使用的关键字「MUST」,「MUST NOT」,「REQUIRED」,「SHALL」,「SHALL NOT」,「SHOULD」,「SHOULD NOT」,「RECOMMENDED」,「MAY」和「OPTIONAL」在RFC2119中被说明。
还未定稿,对规范中提及的点有不赞同的欢迎提出 issues (请添加目录规范
标签)讨论。
目录规范
参加的目录结构为:
.├── .editorconfig├── .travis.yml├── css├── dist├── doc├── README.md├── src
README.md
每个项目都必须「MUST」包含一个README.md
文件,此文件中应当「SHOULD」概要描述此项目的功能和特点等信息。
.editorconfig
每个项目应当「SHOULD」包含.editorconfig
,用来统一配置编辑器的换行、缩进存储格式,使用方式请参考editorconfig是什么?。
src
项目中所有 JS 源码应当「SHOULD」存放在此目录下,且所有JS文件编写应当「SHOULD」遵循Javascript 编码规范。
css、themes、less、sass
样式类文件存放应当「SHOULD」遵循以下规律,且文件编写应当「SHOULD」遵循CSS 编码规范。
- 不带主题的样式文件应当「SHOULD」统一存放在 css 目录下面,且样式中使用的背景图片资源应当「SHOULD」统一存放在
css/images
目录下面。 - 带主题的样式文件应当「SHOULD」统一存放在 themes 目录下对应的主题目录下,默认的主题应当「SHOULD」采用
default
作为主题名称,且应当「SHOULD」默认提供,样式中对应图片文件应当「SHOULD」存放在样式文件所在的主题目录下的images
目录下。 - less 格式的样式文件应当「SHOULD」统一存放在
less
目录下面。 - sass 格式的样式文件应当「SHOULD」统一存放在
sass
目录下面。
doc
所有项目应当「SHOULD」包含一个 doc
目录,用来存放详细的 API 使用文档。
dist
dist 作为项目输出目录,所有编译生成、提供给用户使用的文件应当「SHOULD」存放在此目录。
为了让不太擅长 node.js 的用户可以正常使用编译后的代码,dist 目录应当「SHOULD」包含基本输出结果并提交在 github 中。
build
所有工具类脚本应当「SHOULD」放在此目录。
test
所有测试相关代码应当「SHOULD」放在此目录。
src_cov
为了测试代码覆盖率,所有为测试覆盖率生成的新 JS 文件应当「SHOULD」存放在此目录下面。
- github上的文档结构学习
- github上cocos2dx的说明文档
- github上项目的目录结构说明
- 安装ruby新版本(github上的rbenv文档--)
- GitHub学习-----github上删除自己的repository
- 【python学习.Github上的代码】
- github上的深度学习项目
- github上的几个机器学习程序
- GitHub上的五大开源机器学习项目
- github上的项目
- Github上优秀的
- github上的webrtc
- github上的awesome
- GitHub 上值得关注学习的 iOS 开源项目
- Github上的十大机器学习项目
- Github上的十大机器学习项目
- github 上Android相关应用的链接学习
- GitHub 上值得关注学习的 iOS 开源项目
- 从零开始前端学习[51]:js中去操作css样式以及css属性的替代方法
- 输出
- org.apache.ibatis.binding.BindingException: Invalid bound statement (not found)
- C语言实验——最值
- camke编译caffe
- github上的文档结构学习
- tp5隐藏入口文件index.php
- JavaScript 页面操作 1
- oracle中的聚合函数count、max、min、sum、avg等等
- Git 工作流程
- CentOS7 在线安装 Python3
- 通俗易懂的让你彻底搞懂冒泡排序的由来
- mysql5.7官网直译SQL语句优化--引擎压入条件优化
- Git 工作区、暂存区和版本库