Przeglądaj źródła

docs: CONTRIBUTING

zwlafk 4 lat temu
rodzic
commit
6444591c2b
2 zmienionych plików z 29 dodań i 15 usunięć
  1. 15 8
      CONTRIBUTING-en-US.md
  2. 14 7
      CONTRIBUTING.md

+ 15 - 8
CONTRIBUTING-en-US.md

@@ -2,8 +2,9 @@
 
 
 We are glad that you are interested in contributing to Semi UI. Please take some minutes to read the following guidelines:
 We are glad that you are interested in contributing to Semi UI. Please take some minutes to read the following guidelines:
 ## Branch Management
 ## Branch Management
- - main: Normally, the branch is just a snapshot of the latest stable release. We will merge the `beta` to this branch releasing a minor version every two weeks. If an emergency bug is fixed, we will release a patch version on this branch.
- - beta: For bug fixes and feature development. The beta version will be released based on this branch one week after the minor version is released
+Semi Team will maintain two resident branches: `main` and `release`, we will release the code follow our [Publishing Period](https://semi.design/en-US/start/changelog)
+ - main: This branch is just a snapshot of the **latest stable** release. After minor release, we will merge `release` into this branch.
+ - release: Bug fixes and feature development will merge into this branch first, new version will be released based on this branch on release day.
 ## Bug
 ## Bug
 We use Github issues to track bugs. In order to understand and fix bugs faster, when reporting a bug, you can also reproduce the problem through the template we provide. we recommend you
 We use Github issues to track bugs. In order to understand and fix bugs faster, when reporting a bug, you can also reproduce the problem through the template we provide. we recommend you
 ## Feature
 ## Feature
@@ -16,13 +17,16 @@ To open a Pull Request, please follow the steps below:
 git clone https://github.com/<your-username>/semi-design.git
 git clone https://github.com/<your-username>/semi-design.git
 cd semi-design
 cd semi-design
 ```
 ```
-Before installing the enviroment,make sure that there is a dependency of `lerna` locally, if not, should run:
+ - Checkout a topic branch
 ```bash
 ```bash
-npm install --global lerna
+git checkout -b <TOPIC_BRANCH_NAME>
 ```
 ```
- - Checkout to `beta` branch, install the dependencies
+>Before installing the enviroment,make sure that there is a dependency of `lerna` and `yarn` locally, if not, should run:
+```bash
+npm install --global lerna yarn
+```
+ - Install the dependencies
 ```bash
 ```bash
-git checkout beta
 npm run bootstrap
 npm run bootstrap
 ```
 ```
  - Next, make the modifications you want to make, which can be bug fixes or development of new features
  - Next, make the modifications you want to make, which can be bug fixes or development of new features
@@ -31,7 +35,9 @@ npm run bootstrap
 ```bash
 ```bash
 npm run test:unit
 npm run test:unit
 ```
 ```
- - Open a Pull Request against `beta` of source repo
+ - Open a Pull Request against `release` of source repo
+
+We may ask or help you to modify the PR according to the situation. For inappropriate PR, we will close it with an explanation.
 
 
 ## Help Improve the Docs
 ## Help Improve the Docs
 The documentation site is based on [gatsby](https://www.gatsbyjs.com/), and the code is in the `src` directory.
 The documentation site is based on [gatsby](https://www.gatsbyjs.com/), and the code is in the `src` directory.
@@ -40,8 +46,9 @@ The documentation site is based on [gatsby](https://www.gatsbyjs.com/), and the
 
 
 * Chinese document `packages/semi-ui/tooltip/index.md` 
 * Chinese document `packages/semi-ui/tooltip/index.md` 
 * English document `packages/semi-ui/tooltip/index-en-US.md`
 * English document `packages/semi-ui/tooltip/index-en-US.md`
+
 To get started:
 To get started:
 ```sh
 ```sh
 npm run docsite
 npm run docsite
 ```
 ```
-If you are interested in helping us improve the doc, please modify the md file of the component and submit your changes according to the Pull Request guidelines
+If you are interested in helping us improve the doc, please modify the md file of the component and submit your changes according to the Pull Request guidelines

+ 14 - 7
CONTRIBUTING.md

@@ -3,8 +3,9 @@
 我们很高兴您有兴趣为 Semi UI 做出贡献。 在提交您的贡献之前,请务必花点时间阅读以下指南:
 我们很高兴您有兴趣为 Semi UI 做出贡献。 在提交您的贡献之前,请务必花点时间阅读以下指南:
 
 
 ## 分支管理
 ## 分支管理
- - main: 通常情况下该分支仅作为最新稳定版本代码的快照,用于发布正式版本。每双周会合并`beta`到此分支发布一个 minor 版本。如果修复了紧急 bug,我们会基于此分支修复并发布 patch 版本
- - beta: 用于 bug 修复和 feature 开发。发布 minor 版本后的一周会基于此分支发布 beta 版本
+Semi 团队会维护两个常驻分支:`main` 和 `release`,根据我们的[发布周期](https://semi.design/zh-CN/start/changelog),我们会定期合并代码发布版本
+ - main: 该分支仅作为**最新稳定版本**代码的快照。每次 minor 版本发布后,我们会将 `release` 的代码合并到此分支。
+ - release: bug 修复和 feature 开发等改动,都会率先合并到此分支。在发布日会基于此分支发布新版本。
 ## Bug
 ## Bug
 我们使用 Github issues 来追踪 bug。为了更快地了解和解决 bug,在提交 issue 时,你也可以通过我们提供的模板来重现问题。
 我们使用 Github issues 来追踪 bug。为了更快地了解和解决 bug,在提交 issue 时,你也可以通过我们提供的模板来重现问题。
 ## 新特性
 ## 新特性
@@ -19,13 +20,16 @@ Semi Design 团队会认真对待每一个 Pull Request。我们会 review 并
 git clone https://github.com/<your-username>/semi-design.git
 git clone https://github.com/<your-username>/semi-design.git
 cd semi-design
 cd semi-design
 ```
 ```
-安装环境前确保本地有`lerna`的依赖,如果没有则运行:
+ - 检出你的主题分支
 ```bash
 ```bash
-npm install --global lerna
+git checkout -b <TOPIC_BRANCH_NAME>
 ```
 ```
- - 切换到 `beta` 分支,完成项目依赖安装
+>安装环境前确保本地有 `lerna` 和 `yarn` 的依赖,如果没有则运行:
+```bash
+npm install --global lerna yarn
+```
+ - 完成项目依赖安装
 ```bash
 ```bash
-git checkout beta
 npm run bootstrap
 npm run bootstrap
 ```
 ```
  - 接下来进行你想要做的修改,可以是 bug 修复,也可以是新功能的开发
  - 接下来进行你想要做的修改,可以是 bug 修复,也可以是新功能的开发
@@ -34,7 +38,9 @@ npm run bootstrap
 ```bash
 ```bash
 npm run test:unit
 npm run test:unit
 ```
 ```
- - 新建一个 Pull Request 到源项目的 `beta` 分支
+ - 新建一个 Pull Request 到源项目的 `release` 分支
+
+我们可能会根据情况要求或帮助你修改PR,对于不合适的PR我们会给予解释后关闭
 
 
 ## 帮助改善文档
 ## 帮助改善文档
 文档站基于 [gatsby](https://www.gatsbyjs.com/) 构建,核心代码在 `src` 目录。
 文档站基于 [gatsby](https://www.gatsbyjs.com/) 构建,核心代码在 `src` 目录。
@@ -43,6 +49,7 @@ npm run test:unit
 
 
 * 中文文档 `packages/semi-ui/tooltip/index.md` 
 * 中文文档 `packages/semi-ui/tooltip/index.md` 
 * 英文文档 `packages/semi-ui/tooltip/index-en-US.md`
 * 英文文档 `packages/semi-ui/tooltip/index-en-US.md`
+
 启动文档站点
 启动文档站点
 ```sh
 ```sh
 npm run docsite
 npm run docsite