Skip to content

Commit 9bdc21e

Browse files
committed
增加例子说明,并在中英文间加空格
1 parent 10aef6d commit 9bdc21e

File tree

1 file changed

+38
-17
lines changed

1 file changed

+38
-17
lines changed

project.md

Lines changed: 38 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,40 +7,61 @@
77
文档中使用的关键字「MUST」,「MUST NOT」,「REQUIRED」,「SHALL」,「SHALL
88
NOT」,「SHOULD」,「SHOULD NOT」,「RECOMMENDED」,「MAY」和「OPTIONAL」在[RFC2119](http://oss.org.cn/man/develop/rfc/RFC2119.txt)中被说明。
99

10-
**还未定稿,对规范中提及的点有不赞同的欢迎[提出issues](https://github.com/fex-team/styleguide/issues/new)(请添加`目录规范`标签)讨论。**
10+
**还未定稿,对规范中提及的点有不赞同的欢迎[提出 issues ](https://github.com/fex-team/styleguide/issues/new)(请添加`目录规范`标签)讨论。**
11+
12+
## 目录规范
13+
14+
参加的目录结构为:
15+
16+
```
17+
.
18+
├── .editorconfig
19+
├── css
20+
├── dist
21+
├── doc
22+
├── README.md
23+
├── src
24+
```
25+
26+
### README.md
1127

12-
## README.md
1328
每个项目都必须「MUST」包含一个`README.md`文件,此文件中应当「SHOULD」概要描述此项目的功能和特点等信息。
1429

15-
## .editorconfig
16-
每个项目应当「SHOULD」包含`.editorconfig`,用来统一配置编辑器的换行、缩进存储格式,使用方式请参考(editorconfig是什么?)[https://github.com/fex-team/styleguide/blob/master/editorconfig.md]
30+
### .editorconfig
31+
32+
每个项目应当「SHOULD」包含`.editorconfig`,用来统一配置编辑器的换行、缩进存储格式,使用方式请参考[editorconfig是什么?](https://github.com/fex-team/styleguide/blob/master/editorconfig.md)
1733

18-
## src
34+
### src
1935

2036
项目中所有 JS 源码应当「SHOULD」存放在此目录下,且所有JS文件编写应当「SHOULD」遵循[Javascript 编码规范](https://github.com/fex-team/styleguide/blob/master/javascript.md)
2137

22-
## css、themes、less、sass
38+
### css、themes、less、sass
2339

2440
样式类文件存放应当「SHOULD」遵循以下规律,且文件编写应当「SHOULD」遵循[CSS 编码规范](https://github.com/fex-team/styleguide/blob/master/css.md)
2541

26-
* 不带主题的样式文件应当「SHOULD」统一存放在css目录下面,且样式中使用的背景图片资源应当「SHOULD」统一存放在`css/images`目录下面。
27-
* 带主题的样式文件应当「SHOULD」统一存放在themes目录下对应的主题目录下,默认的主题应当「SHOULD」采用`default`作为主题名称,且应当「SHOULD」默认提供,样式中对应图片文件应当「SHOULD」存放在样式文件所在的主题目录下的`images`目录下。
28-
* less格式的样式文件应当「SHOULD」统一存放在`less`目录下面。
29-
* sass格式的样式文件应当「SHOULD」统一存放在`sass`目录下面。
42+
* 不带主题的样式文件应当「SHOULD」统一存放在 css 目录下面,且样式中使用的背景图片资源应当「SHOULD」统一存放在 `css/images` 目录下面。
43+
* 带主题的样式文件应当「SHOULD」统一存放在 themes 目录下对应的主题目录下,默认的主题应当「SHOULD」采用 `default` 作为主题名称,且应当「SHOULD」默认提供,样式中对应图片文件应当「SHOULD」存放在样式文件所在的主题目录下的 `images` 目录下。
44+
* less 格式的样式文件应当「SHOULD」统一存放在 `less` 目录下面。
45+
* sass 格式的样式文件应当「SHOULD」统一存放在 `sass` 目录下面。
46+
47+
### doc
3048

31-
## doc
3249
所有项目应当「SHOULD」包含一个`doc`目录,用来存放详细的API使用文档。
3350

34-
## dist
35-
dist作为项目输出目录,所有编译生成、提供给用户使用的文件应当「SHOULD」存放在此目录。
51+
### dist
52+
53+
dist 作为项目输出目录,所有编译生成、提供给用户使用的文件应当「SHOULD」存放在此目录。
54+
55+
为了让不太擅长 node.js 的用户可以正常使用编译后的代码,dist 目录应当「SHOULD」包含基本输出结果并提交在 github 中。
3656

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

39-
## build
4059
所有工具类脚本应当「SHOULD」放在此目录。
4160

42-
## test
61+
### test
62+
4363
所有测试相关代码应当「SHOULD」放在此目录。
4464

45-
## src_cov
65+
### src_cov
66+
4667
为了测试代码覆盖率,所有为测试覆盖率生成的新 JS 文件应当「SHOULD」存放在此目录下面。

0 commit comments

Comments
 (0)