Skip to content

Commit 1080258

Browse files
committed
docs: 修改README
1 parent dfc88b6 commit 1080258

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

README-zh-cn.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,19 @@
55

66
X-Developer Analysis Action 在代码提交后,自动触发 X-Developer 团队效能分析并通知分析结果。
77

8-
## 关于 X-Developer
9-
10-
[X-Developer](https://x-developer.cn) 由场量科技研发,是全球第一款事实数据型研发效能度量分析平台。使用 X-Developer 平台及其开源工具,无需购买、设置或管理任何基础设施,您只需登录即可开始开展研发团队效能改进工作。目前,X-Developer 提供了最便捷、完整的研发效能度量解决方案,让您能够以开发者为中心展开改进活动,使您的团队能够围绕目标协同工作,及时同步项目进展,从而将他们从繁重的任务状态维护、项目报告工作中解放出来,集中精力完成研发工作,更好地编写代码,提高业务获得的价值。
8+
> [X-Developer](https://x-developer.cn) 由场量科技研发,是全球第一款事实数据型研发效能度量分析平台。使用 X-Developer 平台及其开源工具,无需购买、设置或管理任何基础设施,您只需登录即可开始开展研发团队效能改进工作。目前,X-Developer 提供了最便捷、完整的研发效能度量解决方案,让您能够以开发者为中心展开改进活动,使您的团队能够围绕目标协同工作,及时同步项目进展,从而将他们从繁重的任务状态维护、项目报告工作中解放出来,集中精力完成研发工作,更好地编写代码,提高业务获得的价值。
119
1210
## 如何使用
1311

14-
当用户向 GitHub 仓库推送或合并请求时,此 Action 使用 GitHub secrets 中配置的 `APPID``APPKEY`,完成 [X-Developer](https://x-developer.cn) 身份认证,并发送 `git log` csv 文件到 X-Developer 对应 `TEAMID` 的团队。
12+
当用户向 GitHub 仓库推送或合并请求时,此 Action 使用 GitHub secrets 中配置的 `APPID``APPKEY`,完成 [X-Developer](https://x-developer.cn) 身份认证,并发送 `git log` csv 文件到 X-Developer 对应 `TEAMID` 的团队,完成效能分析
1513

16-
### 创建您的 X-Developer 帐户
14+
### 1. 创建 X-Developer 帐户
1715

1816
访问 [X-Developer Site](https://x-developer.cn) 网站免费注册。
1917

2018
注册完成后,可在 [API](https://x-developer.cn/accounts/api) 页面查看您的 `APPID` `APPKEY`
2119

22-
### 创建您的团队
20+
### 2. 创建团队
2321

2422
- 免费用户只能创建公开的团队,**所有人均可查看到您的分析结果**,适用于开源项目。
2523
- 私有项目仅对付费用户开放。
@@ -28,13 +26,13 @@ X-Developer Analysis Action 在代码提交后,自动触发 X-Developer 团队
2826
2927
创建团队完成后,即可在 [API](https://x-developer.cn/accounts/api) 页面查看对应的 `TEAMID`
3028

31-
### 创建 GitHub Secrets
29+
### 3. 创建 GitHub Secrets
3230

3331
进入仓库 setting -> secrets, 创建 `APPID` `APPKEY` `TEAMID` 并配置对应的值。
3432

3533
> 如果您使用 GitHub 组织,可以将 `APPID` `APPKEY` 配置在您的组织 `secrets` ,即可被所有仓库使用,以简化操作步骤。
3634
37-
### 使用 Action
35+
### 4. 使用 Action
3836

3937
#### 开发分支
4038

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ This GitHub Action connects GitHub and [X-Developer](https://x-developer.cn) ser
99

1010
This Action authenticate with X-Developer server by GitHub secrets `APPID` and `APPKEY`, it send `git log` csv file to X-Developer team analysis service by `TEAMID` whenever users pushed to or merged pull requests to GitHub repository.
1111

12-
### Create Your X-Developer Account
12+
### 1. Create X-Developer account
1313

1414
Enter [X-Developer Site](https://x-developer.cn) and register an account for free.
1515

1616
Get your `APPID` `APPKEY` from [API](https://x-developer.cn/accounts/api) page.
1717

18-
### Create Your Team
18+
### 2. Create team
1919

2020
- For free users, you could only create public analysis project, **it means everyone could access your team reports,** we recommend this to **opensource project teams.**
2121
- Private project is only for paid users.
@@ -24,13 +24,13 @@ Get your `APPID` `APPKEY` from [API](https://x-developer.cn/accounts/api) page.
2424
2525
Once you created a project, check your `TEAMID` from [API](https://x-developer.cn/accounts/api) page.
2626

27-
### Create GitHub Secrets
27+
### 3. Create GitHub secrets
2828

2929
Enter your repository setting -> secrets, create `APPID` `APPKEY` `TEAMID` and specify the values.
3030

3131
> You could create `APPID` and `APPKEY` in organization `secrets` if you're working in an organization.
3232
33-
### Config Action
33+
### 4. Config action
3434

3535
#### On develop/test branches
3636

0 commit comments

Comments
 (0)