Skip to content

Commit

Permalink
docs: edit 文件名规范
Browse files Browse the repository at this point in the history
  • Loading branch information
ruanyf committed Jan 28, 2017
1 parent 06d108a commit 22db946
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,13 @@
文件名必须使用小写字母,不得使用大写字母。

This comment has been minimized.

Copy link
@wangding

wangding Feb 1, 2017

为什么啊?希望阮老师不吝赐教。

This comment has been minimized.

Copy link
@ruanyf

ruanyf Feb 1, 2017

Author Owner

这是 Linux 传统,主要有两个原因,一是有些系统会自动生成大写的目录名,比如DownloadsDesktopDocuments,小写的文件名可以与系统文件区分;二是,大写需要按下 Shift 键,比较麻烦。

This comment has been minimized.

Copy link
@wangding

wangding Feb 1, 2017

非常感谢,明白了 🙏

```
错误:ChangeLog.md
错误:TroubleShooting.md
正确:changelog.md
正确:troubleshooting.md
```

文档仓库的某些说明文件,为了醒目,可以使用大写的文件名,比如`README``LICENSE`

文件名包含多个单词时,单词之间建议使用半角的连词线(`-`)分隔。

```
Expand Down

0 comments on commit 22db946

Please sign in to comment.