开源项目目录规范

    文档中使用的关键字「MUST」,「MUST NOT」,「REQUIRED」,「SHALL」,「SHALL
    NOT」,「SHOULD」,「SHOULD NOT」,「RECOMMENDED」,「MAY」和「OPTIONAL」在中被说明。

    还未定稿，对规范中提及的点有不赞同的欢迎提出 issues (请添加标签)讨论。

    目录规范

    参加的目录结构为：

    .editorconfig

    每个项目应当「SHOULD」包含.editorconfig，用来统一配置编辑器的换行、缩进存储格式，使用方式请参考。

    src

    项目中所有 JS 源码应当「SHOULD」存放在此目录下，且所有JS文件编写应当「SHOULD」遵循Javascript 编码规范。

    样式类文件存放应当「SHOULD」遵循以下规律，且文件编写应当「SHOULD」遵循。

    • 不带主题的样式文件应当「SHOULD」统一存放在 css 目录下面，且样式中使用的背景图片资源应当「SHOULD」统一存放在 目录下面。
    • 带主题的样式文件应当「SHOULD」统一存放在 themes 目录下对应的主题目录下，默认的主题应当「SHOULD」采用 default 作为主题名称，且应当「SHOULD」默认提供，样式中对应图片文件应当「SHOULD」存放在样式文件所在的主题目录下的 images 目录下。
    • less 格式的样式文件应当「SHOULD」统一存放在 目录下面。

    doc

    dist

    dist 作为项目输出目录，所有编译生成、提供给用户使用的文件应当「SHOULD」存放在此目录。

    为了让不太擅长 node.js 的用户可以正常使用编译后的代码，dist 目录应当「SHOULD」包含基本输出结果并提交在 github 中。

    所有工具类脚本应当「SHOULD」放在此目录。

    test

    src_cov

    为了测试代码覆盖率，所有为测试覆盖率生成的新 JS 文件应当「SHOULD」存放在此目录下面。