mirror/naive-ui
2
0
Fork 0
mirror of https://github.com/tusen-ai/naive-ui.git synced 2025-03-31 14:20:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update contribute md (#2593)

Browse Source 
Co-authored-by: yugang.cao <yugang.cao@tusimple.ai>
This commit is contained in:
Yugang Cao 2022-03-09 19:11:30 +08:00 committed by GitHub
parent fa15c2008e
commit cbdf9419c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
CONTRIBUTING.md
View File

@ -37,23 +37,24 @@ pnpm run build:site
- Add period `.` to each description in English API tables (and each log of changelogs).
- Don't add period `。` in any description in Chinese API tables (and any log of changelogs).
- Add space bewteen Chinese and Latin charactors.
- Add space between Chinese and Latin charactors.
- Don't use Chinese punctuation in English docs.
- Don't write changelogs in a released version.
- When rebase the branch, pay attention to whether it is placed in the released version.
- Add NEXT_VERSION to the version of the API table.
For Example:
```
English API table:
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| example | `any` | `undefined` | Need period. |
| Name | Type | Default | Description | Version |
| --- | --- | --- | --- | --- |
| example | `any` | `undefined` | Need period. | NEXT_VERSION |
Chinese API table:
| 名称 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| example | `any` | `undefined` | 描述不要加句号 |
| 名称 | 类型 | 默认值 | 说明 | 版本 |
| --- | --- | --- | --- | --- |
| example | `any` | `undefined` | 描述不要加句号 | NEXT_VERSION |
English Changelog:
- Some changes, period needed.
@ -61,14 +62,14 @@ English Changelog:
Chinese Changelog:
- 一些变更，不要加句号
Space bewteen Chinese and Latin charactors:
Space between Chinese and Latin charactors:
星之 star 卡比 kirby
Changelog position:
# CHANGELOG
## 2.24.2
## NEXT_VERSION
### Feats
@ -120,19 +121,20 @@ pnpm run build:site
- 不要在英文文档中使用中文标点
- 不要写在已经发布的版本中
- rebase 分支时注意是否放到已发布的版本中
- 添加 NEXT_VERSION 到 API 表格的版本上
例如:
```
英文 API 表格：
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| example | `any` | `undefined` | Need period. |
| Name | Type | Default | Description | Version |
| --- | --- | --- | --- | --- |
| example | `any` | `undefined` | Need period. | NEXT_VERSION |
中文 API 表格：
| 名称 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| example | `any` | `undefined` | 描述不要加句号 |
| 名称 | 类型 | 默认值 | 说明 | 版本 |
| --- | --- | --- | --- | --- |
| example | `any` | `undefined` | 描述不要加句号 | NEXT_VERSION |
English Changelog:
- Some changes, period needed.
@ -147,7 +149,7 @@ Changelog 位置：
# CHANGELOG
## 2.24.2
## NEXT_VERSION
### Feats