├── .nojekyll
├── LICENSE
├── README.md
├── _sidebar.md
├── contributing
├── branch.md
├── changelog.md
├── commit.md
├── pr.md
└── workflow.md
├── index.html
├── others
├── compatibility.md
└── copywriter.md
└── style
├── basic.md
├── html.md
└── javascript.md
/.nojekyll:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/PDFE/GUIDELINE/80fb868ec762c2877a06fc3c4e876cee60de5d68/.nojekyll
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2018 DanmakuFrontendProject
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # GUIDELINE
2 |
3 | > 没有规矩，不成方圆
4 | No rules, no standards
5 |
6 | https://pdfe.github.io/GUIDELINE/#/
7 |
8 | ## Intro
9 |
10 | 📖 贡献规则和代码风格指南
11 | The contributing rules and code style guide
12 |
13 | ## Dev
14 |
15 | ### Requirement
16 |
17 | - [Node.js](https://github.com/nodejs/node)
18 | - [docsify-cli](https://github.com/QingWei-Li/docsify-cli)
19 |
20 | ```bash
21 | # install docsify-cli
22 | $ npm i docsify-cli -g
23 | ```
24 |
25 | ### Usage
26 |
27 | ```bash
28 | $ git clone https://github.com/PDFE/GUIDELINE.git
29 | $ cd GUIDELINE
30 | # docsify serve [--open false] [--port 3000]
31 | $ docsify serve .
32 | ```
33 |
34 | ## Contributing
35 |
36 | All kinds of contributions and improvements, issues to GUIDELINE are welcome.
37 |
38 | ## Maintainer
39 |
40 | **PDFE GUIDELINE** © [Project Danmaku Front-End Team](https://github.com/PDFE), Released under the [MIT](./LICENSE) License.
41 | Authored and maintained by PDFE Team with help from contributors ([list](https://github.com/PDFE/GUIDELINE/contributors)).
42 |
--------------------------------------------------------------------------------
/_sidebar.md:
--------------------------------------------------------------------------------
1 | - **贡献规则**
2 | - [Workflow 工作流](/contributing/workflow)
3 | - [Commit 信息规范](/contributing/commit)
4 | - [Branch 命名规范](/contributing/branch)
5 | - [Changelog 规范](/contributing/changelog)
6 | - [Pull Request 规范](/contributing/pr)
7 |
8 | - **代码风格**
9 | - [基本约定](/style/basic)
10 | - [HTML 代码风格](style/html)
11 |
12 | - **其它**
13 | - [中文文案风格指南](/others/copywriter)
14 | - [浏览器兼容性指导意见](/others/compatibility)
15 |
--------------------------------------------------------------------------------
/contributing/branch.md:
--------------------------------------------------------------------------------
1 | # Branch 命名规范
2 |
3 | ```
4 | //
5 | ```
6 |
7 | ## Type
8 |
9 | Type 用于标记这个分支的作用。下面是一些例子：
10 |
11 | feat: 新的特性、新的功能
12 | fix: 修复 Bugs
13 | docs: 关于文档的更新
14 | style: 代码格式化，代码简化等（不影响代码的运行）
15 | refactor: 重构（没有新特性增加也没有 Bug 被修复）
16 | test: 项目测试
17 | chore: 升级工具（如 gulpfile 的更新）
18 | ci: 修改 CI 的流程
19 | remove: 简单地将部分模块的代码从项目中移除
20 |
21 | 一个分支可以包含一或两个 Type。
22 |
23 | ## Scope
24 |
25 | 用 1 到 2 个单词注明项目中的哪一部分、哪一模块会被影响
26 |
27 | ## Subject(Not necessary)
28 |
29 | 用 1 到 2 个单词注明项目中这一部分中的哪些代码会被影响，或简单注明为什么新建了这个分支
30 |
31 | ---
32 |
33 | 以下是几个复合规范的 Branch 命名的样例：
34 |
35 | ```
36 | feat/player
37 | fix/index/navbar
38 | refactor/user/new-design
39 | ```
40 |
--------------------------------------------------------------------------------
/contributing/changelog.md:
--------------------------------------------------------------------------------
1 | # 更新日志规范
2 |
3 | Changelog 应该包含以下几个部分：
4 |
5 | - Fetures
6 | - Changes
7 | - Bugs Fixed
8 | - Breaking Changes
9 |
10 | 公开的 Changelog 需要带上 issue 和 pr 的对应编号、URL 或者 commit hash。
11 |
--------------------------------------------------------------------------------
/contributing/commit.md:
--------------------------------------------------------------------------------
1 | # Commit Message 规范
2 |
3 | !> 所有成员必须遵守该规范。否则 PR 将会被以 `Squash` 的形式合并，推送到主分支的代码将会被 Force 回退。
4 |
5 | ```
6 | ():
7 |
8 |
9 |
10 |