Skip to content

Commit

Permalink
[chore] update community contribution.md files (#2199)
Browse files Browse the repository at this point in the history
Signed-off-by: yuluo-yx <[email protected]>
Co-authored-by: Logic <[email protected]>
  • Loading branch information
yuluo-yx and zqr10159 authored Jul 5, 2024
1 parent 9b31fe7 commit 97e5435
Showing 1 changed file with 12 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ sidebar_position: 0

> 在 HertzBeat 社区,贡献方式有很多:
- 💻**代码**:可以帮助社区完成一些任务、编写新的feature或者是修复一些bug
- 💻**代码**:可以帮助社区完成一些任务、编写新的 feature 或者是修复一些 bug

- ⚠️**测试**:可以来参与测试代码的编写,包括了单元测试、集成测试、e2e测试
- ⚠️**测试**:可以来参与测试代码的编写,包括了单元测试、集成测试、e2e 测试

- 📖**文档**:可以编写或完善文档,来帮助用户更好地了解和使用 HertzBeat;

- 📝**博客**:可以撰写 HertzBeat 的相关文章,来帮助社区更好地推广;

- 🤔**讨论**:可以参与 HertzBeat 新的feature的讨论,将您的想法跟 HertzBeat 融合;
- 🤔**讨论**:可以参与 HertzBeat 新的 feature 的讨论,将您的想法跟 HertzBeat 融合;

- 💡**布道**:可以帮助宣传或推广 HertzBeat 社区,在 meetup 或 summit 中演讲;

Expand All @@ -62,31 +62,31 @@ sidebar_position: 0

#### 前端启动

1. 需要 `nodejs yarn` 环境, Make sure `Node.js >= 18`
1. 需要 `nodejs yarn` 环境, 确保 `Node.js >= 18`

2. 进入 `web-app` 目录: `cd web-app`

3. 安装yarn: `npm install -g yarn`
3. 安装 yarn: `npm install -g yarn`

4. 在前端工程目录 `web-app` 下执行: `yarn install` or `yarn install --registry=https://registry.npmmirror.com` in `web-app`

5. 全局安装 `angular-cli`: `yarn global add @angular/cli@15` or `yarn global add @angular/cli@15 --registry=https://registry.npmmirror.com`

6. 待本地后端启动后,在web-app目录下启动本地前端 `ng serve --open`
6. 待本地后端启动后,在 web-app 目录下启动本地前端 `ng serve --open`

7. 浏览器访问 localhost:4200 即可开始,默认账号密码 **admin/hertzbeat**

### 寻找任务

寻找您感兴趣的Issue!在我们的GitHub仓库和邮件列表中,我们经常会发布一些带有 good first issue 或者 status: volunteer wanted 标签的issue,这些issue都欢迎贡献者的帮助。
其中good first issue往往门槛较低、适合新手。
寻找您感兴趣的 Issue!在我们的 GitHub 仓库和邮件列表中,我们经常会发布一些带有 good first issue 或者 status: volunteer wanted 标签的 issue,这些issue都欢迎贡献者的帮助。
其中 good first issue 往往门槛较低、适合新手。

当然,如果您有好的想法,也可以直接在GitHub Discussion 中提出或者联系社区。
当然,如果您有好的想法,也可以直接在 GitHub Discussion 中提出或者联系社区。

### 提交 Pull Request

1. 首先您需要 Fork 目标仓库 [hertzbeat repository](https://github.com/apache/hertzbeat).
2. 然后 用git命令 将代码下载到本地:
2. 然后 用 git 命令 将代码下载到本地:
```shell
git clone [email protected]:${YOUR_USERNAME}/hertzbeat.git #Recommended
```
Expand All @@ -95,7 +95,7 @@ git clone [email protected]:${YOUR_USERNAME}/hertzbeat.git #Recommended
```shell
git checkout -b a-feature-branch #Recommended
```
5. 提交 commit , commit 描述信息需要符合约定格式: [module name or type name]feature or bugfix or doc: custom message.
5. 提交 commit, commit 描述信息需要符合约定格式: [module name or type name]feature or bugfix or doc: custom message.
```shell
git add <modified file/path>
git commit -m '[docs]feature: necessary instructions' #Recommended
Expand Down Expand Up @@ -135,7 +135,7 @@ git checkout master
git pull upstream master
```

### 如何成为Committer
### 如何成为 Committer

通过上述步骤,您就是 HertzBeat 的贡献者了。重复前面的步骤,在社区中保持活跃,坚持下去,您就能成为 Committer!

Expand Down

0 comments on commit 97e5435

Please sign in to comment.