TODO.md

东北大学组织（neu-1923）Github Page

简介

页面目的

本页面应提供或展示以下几个服务和信息：

• 提供申请加入组织的入口
• 提供组织内开坑的入口（页面）
• 目前的项目状态介绍
• 组织成员的介绍页
• Git使用规范以及语言规范

技术方面

网站使用npm管理依赖，前端使用vue 2.0框架，webpack打包，并使用eslint检查语法。

Git使用规范

有权限的用户请不要直接push到master或review分支，合并代码请尽量使用git rebase保持线性历史。

步骤

git clone ...

# ...

git add & commit

git pull --rebase

# 简单测试并解决冲突

git push

项目规范

全局使用UTF-8格式编码

目录结构

• 源代码放在src/目录下
• 资源文件放在src/asset/目录下
• 配置文件放在根目录下
• 编译结果放在dist/目录下

在代码中@指向src目录。，可以直接使用@/src与@/src/assets。

语言规范

2缩进，使用空格。

Vue

组件文件以大写开头命名，在文件开始位置加上一定的注释。同一层级的组件放在同一目录内。

文件内容以template-script-style顺序组织，块之间空两行。

Template

Script

会自动使用Babel对高版本代码兼容，目前使用ES7 stage3。

在提交之前使用ESLint会对代码质量进行检查，没有问题后再提交。

• 不要在行末尾加多余的分号（ESLint会提醒）。
• 函数之间空一行
• 减少使用function关键字次数
• 对自定义的函数添加注释，必须包括函数功能和参数列表。
• 所有import、require写在块的头部。
• 注意代码的重用，减少拷贝。

Style

使用less作为样式模版。

注意style块的继承（scoped属性）。