命题

命题规范

主要是为了让命名在项目中一至,代码可以通过命名有很好的解释使人更好的理解。

类别

目录:全部小写为主,个人习惯连字符使用-中划线,一按作用使用常用单词表示
文件:使用-中划线进行连接。和目录的连接字符保持一致。但是linux系统文件推荐的文件命名一般是下划线。
变量:下划线命名法: my_variable
驼峰式命名法(CamelCase): 指混合使用大小写字母
CSS:推荐使用中划线进行连接
**JavaScript:变量推荐驼峰式命名法

良好习惯

自律 探究 理解 清晰 简明 独一 学习
  • 对于属性或类名,应该总是名词在最后面,修饰词在名词前
  • 对于方法,应该总是动词开头,名词结尾

书写文档

旧流程

1。编写好文章内容
2.创建新的issue去追踪特征
3.发起pull request去迭代更新文档内容
4.使用@提醒团队并使其审查内容
5.使用webhook在内容仓库快速激活部署的rails应用软件,负责更新数据库

新流程

使用Jekyll2.0

开源协议

目录结构

src

css(styles): 样式文件
js(scripts): 脚本文件
img(images): 图片素材
font(fonts): 存放字体
其他: 按照分类不同划分目录

dist

编译生成目录,用于部署环境,目录结构和src保持一致

test

测试目录,存放和项目测试相关的文件。

doc

文档说明,放置在此目录下。

其他

editorconfig: 代码样式统一格式文件
.jscsrc:
.travis.yml:
.jshintrc: jshint配置文件
csscomb.json: csscomb配置文件
.gitignore: git忽略文件
.gitattributes: git属性文件
.bowerrc
bower.json
package.json
gruntfile.js/gulpfile.js

重点:GitHub(之后要重点运用的一个软件)

你可能感兴趣的:(命题)