CONTRIBUTING.md

To better collaborate on a website, it is recommended that you read through this contributing guideline.

为了让您能更好地协作开发网站，建议您详细阅读以下的开发原则。

Technical details - 技术细节

• NodeJs is used as the main controller, router, and backend provider;

• Pug (called Jade before) is used as the template engine;

• Stylus is used as the styling engine;

• Bootstrap is used as the main styling framework;

• ImageMagick is used as the images processor;

• 主控制器、网页路由、后端，使用的是 NodeJs 环境;

• 网页模版引擎使用 Pug（曾用名 Jade）;

• 样式表引擎使用 Stylus;

• 样式主框架为 Bootstrap;

• 调用 ImageMagick 处理图像.

Development environment - 开发环境

A valid nodejs install is the first one you need.

Don't forget npm install and (for example,) apt install imagemagick

您只需要安装好 nodejs 就行。

别忘了执行一次 npm install 以及（比如）apt install imagemagick。

Branches - 分支

NEVER push onto master, main development branch is develop, you may start a branch whenever needed.

绝不允许 向 master 分支提交开发内容。主开发分支位与 develop， 当然你也可以在任何时候创建一个新的分支。

Coding Style - 代码风格

TODO: Translate this section to English.

通用规则

• Don't Repeat Yourself;
• 缩进 2 个空格;
• Stylus, Pug 使用双引号，Javascript 使用单引号;
• Javascript 中任何变量必须有明确定义;
• 自建类名使用 afe- 作为前缀;
• 代码风格（Pug 有一些特例，见下文）;

  function(x, y) {
    a = b + 1;
  }
  

• 极力避免肮脏的、语义晦涩难懂的代码，如有必要，必须书写清晰的注释说明;
• Pug 中的开发注释使用 //- 避免编译到 HTML 中;
• 兼容上，不考虑 IE9 及以前版本的浏览器。

Stylus

.afe-blah
  key1: value

.afe-foo
  key1: value value value
  key2: value value
  functionA()
  functionB(x, y)
  &:hover
    key1: value

Pug

• 如果一个节点，有且仅有一个子节点，而且该结构不常更改，那么使用简写：parent: child
• 代码风格（等号无空格, Javascript 语法的等号有空格，属性之间用逗号）

  tag(key1="value", key2="value")
  - var a = b;