feat: add CONTRIBUTING.md document.

This commit is contained in:
jaywcjlove
2022-09-29 02:40:26 +08:00
parent 719da7d477
commit efa51c0a06
19 changed files with 573 additions and 214 deletions

View File

@ -21,7 +21,6 @@ Semver 备忘清单
| `主版本号(MAJOR)` | 当你做了不兼容的 API 修改 |
| `次版本号(MINOR)` | 当你做了向下兼容的功能性新增 |
| `修订号(PATCH)` | 当你做了向下兼容的问题修正 |
<!--rehype:class=table-thead-hide-->
### 简单范围
@ -38,7 +37,6 @@ Semver 备忘清单
### 范围
<!--rehype:wrap-class=row-span-3-->
<!--rehype:-->
| 范围 | 描述 | Notes |
| --- | --- | --- |
| `~1.2.3` | 是 `>=1.2.3 <1.3.0` | |
@ -54,15 +52,14 @@ Semver 备忘清单
| `1` | 相同的 | |
| `*` | 任何版本 | |
| `x` | 相同的 | |
<!--rehype:class=table-thead-hide-->
### 连字符范围
<!--rehype:wrap-class=row-span-3-->
<!--rehype:-->
| 范围 | 描述 |
| --- | --- |
| `1.2.3 - 2.3.4` | 是 `>=1.2.3 <=2.3.4` |
<!--rehype:className=show-header -->
#### 部分向右
@ -70,14 +67,12 @@ Semver 备忘清单
| --- | --- |
| `1.2.3 - 2.3` | 是 `>=1.2.3 <2.4.0` |
| `1.2.3 - 2` | 是 `>=1.2.3 <3.0.0` |
<!--rehype:class=table-thead-hide-->
#### 部分向左
| 范围 | 描述 |
| --- | --- |
| `1.2 - 2.3.0` | 是 `1.2.0 - 2.3.0` |
<!--rehype:class=table-thead-hide-->
当右侧为部分(例如,`2.3`)时,假定缺失的部分为`x`(例如,` 2.3.x`)。
@ -89,6 +84,7 @@ Semver 备忘清单
| --- | --- |
| `>=0.14 <16` | 和 (空格分隔) |
| `0.14.x \|\| 15.x.x` | 或 (双竖线分隔) |
<!--rehype:className=show-header -->
### 预发布
@ -104,7 +100,6 @@ Semver 备忘清单
| `~` | 意思是“相当接近” |
| `0.x.x` | 用于“初始开发” |
| `1.x.x` | 表示定义了公共 API |
<!--rehype:class=table-thead-hide-->
另见