Skip to content

Commit d283f77

Browse files
committed
docs: add contributing guidelines and versioning rules
1 parent d0efa2d commit d283f77

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing
2+
3+
## 开发指南
4+
5+
### 环境要求
6+
7+
- node 版本:[package.json](./package.json) `engines.node`
8+
- pnpm 版本:[package.json](./package.json) `packageManager`
9+
10+
建议通过 node 自带的 corepack 来自动安装仓库要求的 pnpm:
11+
```sh
12+
corepack enable
13+
```
14+
15+
### 本地启动
16+
17+
**安装依赖:**
18+
19+
```sh
20+
pnpm i
21+
```
22+
23+
**启动插件调试窗口:**
24+
25+
通过 `F5` 启动插件调试窗口(宿主扩展窗口)。
26+
27+
## 插件发版规范
28+
29+
VS Code 插件版本号规范目前仅遵循 `major.minor.patch`,未来也许会支持完整的 [Semver] 规范。根据 VS Code [官方建议][参考],Mpx 插件的版本号应遵循以下规则:
30+
31+
- 正式版本(Release):`major.EVEN_NUMBER.patch``minor` 偶数版本),例如:`1.2.x`
32+
33+
- 预发布版本(Pre-Release):`major.ODD_NUMBER.patch``minor` 奇数版本),例如:`1.3.x`
34+
35+
> [!NOTE]
36+
>
37+
> 如果存在比预发布版本更高的正式版本,用户也可以自动更新到正式版本。
38+
39+
<!-- Reference Links -->
40+
41+
[Semver]: https://semver.org/lang/zh-CN/
42+
[参考]: https://code.visualstudio.com/api/working-with-extensions/publishing-extension#prerelease-extensions

0 commit comments

Comments
 (0)