Skip to content

Commit

Permalink
docs: fix contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
07akioni committed Jan 8, 2024
1 parent 6401ba5 commit ff7499f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,20 @@ pnpm run build:site
- 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 2.37.0 to the version of the API table.
- Add NEXT_VERSION to the version of the API table.

For Example:

```
English API table:
| Name | Type | Default | Description | Version |
| --- | --- | --- | --- | --- |
| example | `any` | `undefined` | Need period. | 2.37.0 |
| example | `any` | `undefined` | Need period. | NEXT_VERSION |
Chinese API table:
| 名称 | 类型 | 默认值 | 说明 | 版本 |
| --- | --- | --- | --- | --- |
| example | `any` | `undefined` | 描述不要加句号 | 2.37.0 |
| example | `any` | `undefined` | 描述不要加句号 | NEXT_VERSION |
English Changelog:
- Some changes, period needed.
Expand All @@ -70,7 +70,7 @@ Changelog position:
# CHANGELOG
## 2.37.0
## NEXT_VERSION
### Feats
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,20 @@ pnpm run build:site
- 不要在英文文档中使用中文标点
- 不要写在已经发布的版本中
- rebase 分支时注意是否放到已发布的版本中
- 添加 2.37.0 到 API 表格的版本上
- 添加 NEXT_VERSION 到 API 表格的版本上

例如:

```
英文 API 表格:
| Name | Type | Default | Description | Version |
| --- | --- | --- | --- | --- |
| example | `any` | `undefined` | Need period. | 2.37.0 |
| example | `any` | `undefined` | Need period. | NEXT_VERSION |
中文 API 表格:
| 名称 | 类型 | 默认值 | 说明 | 版本 |
| --- | --- | --- | --- | --- |
| example | `any` | `undefined` | 描述不要加句号 | 2.37.0 |
| example | `any` | `undefined` | 描述不要加句号 | NEXT_VERSION |
English Changelog:
- Some changes, period needed.
Expand All @@ -70,7 +70,7 @@ Changelog 位置:
# CHANGELOG
## 2.37.0
## NEXT_VERSION
### Feats
Expand Down

0 comments on commit ff7499f

Please sign in to comment.