Skip to content

Commit

Permalink
chore: 添加贡献文档和ChangeLog
Browse files Browse the repository at this point in the history
  • Loading branch information
x-cold committed Oct 25, 2016
1 parent a62ca6c commit 8b8d84c
Show file tree
Hide file tree
Showing 6 changed files with 79 additions and 59 deletions.
16 changes: 13 additions & 3 deletions README-zh.md
Expand Up @@ -9,16 +9,16 @@ N3-components - 强大的Vue组件库。

N3组件库是基于Vue.js构建的,让前端工程师和全栈工程师能快速构建页面和应用。

[官方主页](https://n3-components.github.io/N3-components/) | [English Introduction](./README.md) | [文档](https://n3-components.github.io/N3-components/component.html)
[官方主页](https://n3-components.github.io/N3-components/) | [English Introduction](https://github.com/N3-components/N3-components) | [文档](https://n3-components.github.io/N3-components/component.html)

相关介绍
------------

![logo](./docs/static/img/logo.png)
![logo](https://raw.githubusercontent.com/N3-components/N3-components/master/docs/static/img/logo.png)

N3组件库致力于构建良好的Vue开发者生态圈,提供良好的开发体验。下面是其中的一些特色:

* 超过60个组件 [组件列表](./src)
* 超过60个组件 [组件列表](https://github.com/N3-components/N3-components/tree/master/src)

* 自定义样式

Expand Down Expand Up @@ -74,3 +74,13 @@ TODO 列表
- QQ群: 556286036 <a target="_blank" href="http://shang.qq.com/wpa/qunwpa?idkey=ae2b542ef32e8595664c746572d9a48187167e269ef5b6c80d8ed326fce5efdd"><img border="0" src="http://pub.idqqimg.com/wpa/images/group.png" alt="N3-components交流群" title="N3-components交流群"></a>
- QQ群二维码:
![qrcode](https://n3-components.github.io/N3-components/static/img/N3-QQ.png)

提交贡献
---------

[Contribute](https://github.com/N3-components/N3-components/blob/master/contribute.md)

更新日志
---------

[Change Log](https://github.com/N3-components/N3-components/blob/master/log.md)
15 changes: 13 additions & 2 deletions README.md
Expand Up @@ -9,7 +9,7 @@ N3-components - Powerful Vue Library.

N3 components library is built with Vue.js, is a powerful library for frontend or full-stack engineers to build web pages quickly.

[Home Page](https://n3-components.github.io/N3-components/) | [中文说明](./README-zh.md) | [Documents](https://n3-components.github.io/N3-components/component.html)
[Home Page](https://n3-components.github.io/N3-components/) | [中文说明](https://github.com/N3-components/N3-components/blob/master/README-zh.md) | [Documents](https://n3-components.github.io/N3-components/component.html)

Introduction
------------
Expand All @@ -18,7 +18,7 @@ Introduction

N3 components applys oneself to structure a great ecological circle of developers using Vue.js. Supporting as follows:

* More than 60 components. [See Here](./src)
* More than 60 components. [See Here](https://github.com/N3-components/N3-components/tree/master/src)

* Personality Of Style.

Expand Down Expand Up @@ -74,3 +74,14 @@ Discussing
- QQ Group: 556286036 <a target="_blank" href="http://shang.qq.com/wpa/qunwpa?idkey=ae2b542ef32e8595664c746572d9a48187167e269ef5b6c80d8ed326fce5efdd"><img border="0" src="http://pub.idqqimg.com/wpa/images/group.png" alt="N3-components交流群" title="N3-components交流群"></a>
- QQ Group Qrcode:
![qrcode](https://n3-components.github.io/N3-components/static/img/N3-QQ.png)


Contribute
---------

[Contribute](https://github.com/N3-components/N3-components/blob/master/contribute.md)

Change logo
--------

[Change Log](https://github.com/N3-components/N3-components/blob/master/log.md)
44 changes: 44 additions & 0 deletions contribute.md
@@ -0,0 +1,44 @@
贡献提交方式
---------

[Guide指引](https://guides.github.com/activities/contributing-to-open-source/)

commit 提交规范
---------

#### commit 编写标准

命名统一为:`<type>(<scope>): <subject>`

```
1. type — 提交 commit 的类型
○ feat: 新功能
○ fix: 修复问题
○ docs: 修改文档
○ style: 修改代码格式,不影响代码逻辑
○ refactor: 重构代码,理论上不影响现有功能
○ perf: 提升性能
○ test: 增加修改测试用例
○ chore: 修改工具相关(包括但不限于文档、代码生成等)
○ deps: 升级依赖
2. scope — 修改文件的范围,可选,包括但不限于 doc / plugins 等。
3. subject — 用一句话清楚的描述这次提交做了什么。
```

#### javascript 项目 commit 提交规范提醒工具

```bash
npm install ghooks --save-dev
npm install validate-commit-msg --save-dev
```

package.json 中添加

```json
"config": {
"ghooks": {
"commit-msg": "validate-commit-msg"
}
}
```

8 changes: 8 additions & 0 deletions log.md
@@ -0,0 +1,8 @@
v1.1.x
--------

#### v1.1.9

+ 修复dataTable组件的警告内容

+ 修复tree组件expand-all无效的问题
2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "N3-components",
"version": "1.1.8",
"version": "1.1.9",
"description": "N3 built with Vue.js",
"main": "dist/N3Components.min.js",
"homepage": "https://n3-components.github.io/N3-components/index.html",
Expand Down
53 changes: 0 additions & 53 deletions webpack.config.js

This file was deleted.

0 comments on commit 8b8d84c

Please sign in to comment.