From a57fee7d684a8407eb3fafe7cfa0b69e7be910ac Mon Sep 17 00:00:00 2001 From: Pratyay Banerjee Date: Mon, 23 Sep 2024 08:44:27 +0530 Subject: [PATCH] docs: add CHAOSS metrics (EN + ZH) + refactoring (#45) * [docs]: new-changes (content + refactorize) Signed-off-by: neilblaze * [docs]: new-changes (content + refactorize) - v2 Signed-off-by: neilblaze * [docs]: new-changes (content + refactorize) - v3 Signed-off-by: neilblaze * refactor: update ZH docs Signed-off-by: frank-zsy * refactor: update ZH docs Signed-off-by: frank-zsy --------- Signed-off-by: neilblaze Signed-off-by: frank-zsy Co-authored-by: frank-zsy --- docs/user_docs/intro.md | 24 ++++++------- .../metrics/activity_dates_and_times.md | 2 +- .../metrics/change_request_reviews.md | 2 +- docs/user_docs/metrics/change_requests.md | 2 +- .../metrics/change_requests_accepted.md | 2 +- docs/user_docs/metrics/change_requests_age.md | 2 +- .../change_requests_resolution_duration.md | 2 +- .../metrics/change_requests_response_time.md | 2 +- docs/user_docs/metrics/code_changes_lines.md | 31 +++++++++++++++++ .../metrics/contributor_absence_factor.md | 2 +- docs/user_docs/metrics/contributors.md | 30 ++++++++++++++++ .../metrics/inactive_contributors.md | 2 +- docs/user_docs/metrics/issue_age.md | 29 ++++++++++++++++ docs/user_docs/metrics/issue_closed.md | 29 ++++++++++++++++ docs/user_docs/metrics/issue_new.md | 29 ++++++++++++++++ .../metrics/issue_resolution_duration.md | 2 +- docs/user_docs/metrics/issue_response_time.md | 8 ++--- docs/user_docs/metrics/new_contributors.md | 4 +-- docs/user_docs/{ => metrics}/playground.mdx | 0 docs/user_docs/metrics/technical_fork.md | 2 +- .../current/user_docs/intro.md | 24 ++++++------- .../user_docs/metrics/code_changes_lines.md | 34 +++++++++++++++++++ .../current/user_docs/metrics/contributors.md | 33 ++++++++++++++++++ .../current/user_docs/metrics/issue_age.md | 32 +++++++++++++++++ .../current/user_docs/metrics/issue_closed.md | 34 +++++++++++++++++++ .../current/user_docs/metrics/issue_new.md | 32 +++++++++++++++++ .../user_docs/metrics/issue_response_time.md | 4 +-- sidebars.js | 7 +++- src/css/custom.css | 34 +++++++++++-------- 29 files changed, 382 insertions(+), 58 deletions(-) create mode 100644 docs/user_docs/metrics/code_changes_lines.md create mode 100644 docs/user_docs/metrics/contributors.md create mode 100644 docs/user_docs/metrics/issue_age.md create mode 100644 docs/user_docs/metrics/issue_closed.md create mode 100644 docs/user_docs/metrics/issue_new.md rename docs/user_docs/{ => metrics}/playground.mdx (100%) create mode 100644 i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/code_changes_lines.md create mode 100644 i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/contributors.md create mode 100644 i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_age.md create mode 100644 i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_closed.md create mode 100644 i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_new.md diff --git a/docs/user_docs/intro.md b/docs/user_docs/intro.md index 4a39583..13780db 100644 --- a/docs/user_docs/intro.md +++ b/docs/user_docs/intro.md @@ -27,28 +27,28 @@ OpenDigger 实现的所有指标对所有人开放使用, 您可以通过以下 - 仓库全域 OpenRank + 仓库全域 OpenRank X-lab openrank.json 链接 Demo - 开发者全域 OpenRank - X-lab + 开发者全域 OpenRank + X-lab openrank.json 链接 - Demo + Demo - 仓库社区 OpenRank + 仓库社区 OpenRank X-lab community_openrank.json 链接 Demo - 开发者社区 OpenRank + 开发者社区 OpenRank X-lab - 链接 @@ -151,7 +151,7 @@ OpenDigger 实现的所有指标对所有人开放使用, 您可以通过以下 new_contributors_detail.json - 贡献者 + 贡献者 CHAOSS contributors.json 链接 @@ -175,7 +175,7 @@ OpenDigger 实现的所有指标对所有人开放使用, 您可以通过以下 Demo - 贡献者缺席因素 + 贡献者缺席因素 CHAOSS bus_factor.json 链接 @@ -203,14 +203,14 @@ OpenDigger 实现的所有指标对所有人开放使用, 您可以通过以下 - 新问题 + 新问题 CHAOSS issues_new.json 链接 Demo - 已关闭的问题 + 已关闭的问题 CHAOSS issues_closed.json 链接 @@ -236,7 +236,7 @@ OpenDigger 实现的所有指标对所有人开放使用, 您可以通过以下 Demo - 问题年龄 + 问题年龄 CHAOSS issue_age.json 链接 @@ -301,7 +301,7 @@ OpenDigger 实现的所有指标对所有人开放使用, 您可以通过以下 Demo - 代码更改行 + 代码更改行 CHAOSS code_change_lines_add.json 链接 diff --git a/docs/user_docs/metrics/activity_dates_and_times.md b/docs/user_docs/metrics/activity_dates_and_times.md index d00832a..0de5b28 100644 --- a/docs/user_docs/metrics/activity_dates_and_times.md +++ b/docs/user_docs/metrics/activity_dates_and_times.md @@ -4,7 +4,7 @@ ## 定义 -活动日期和时间 (Activity Dates and Times) 是一个由 [CHAOSS](https://chaoss.community) 定义的指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - Activity Dates and Times](https://chaoss.community/kb/metric-activity-dates-and-times/)。 +活动日期和时间 (Activity Dates and Times) 是由 [CHAOSS](https://chaoss.community) 定义的指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - Activity Dates and Times](https://chaoss.community/zh-CN/kb/metric-activity-dates-and-times/)。 该指标有助于确定存储库中单个活动发生的日期和时间戳。它还有助于确定存储库的活动情况以及存储库最活跃的时间。 diff --git a/docs/user_docs/metrics/change_request_reviews.md b/docs/user_docs/metrics/change_request_reviews.md index d5f699b..dcbc2b0 100644 --- a/docs/user_docs/metrics/change_request_reviews.md +++ b/docs/user_docs/metrics/change_request_reviews.md @@ -4,7 +4,7 @@ ## 定义 -变更请求审查（Change Request Reviews）是由 [CHAOSS](https://chaoss.community) 定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - 变更请求审查](https://chaoss.community/kb/metric-change-request-reviews/)。 +变更请求审查（Change Request Reviews）是由 [CHAOSS](https://chaoss.community) 定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - 变更请求审查](https://chaoss.community/zh-CN/kb/metric-change-request-reviews/)。 该指标是软件开发过程中的一个关键组成部分，确保在集成之前对代码库的建议修改进行全面评估。这个过程包括评估变更的质量，并确保其符合项目指南。审查可以在合并之前建议改进或必要的更改，从而促进软件质量和最佳实践的遵循。 diff --git a/docs/user_docs/metrics/change_requests.md b/docs/user_docs/metrics/change_requests.md index 45ce995..7d54e67 100644 --- a/docs/user_docs/metrics/change_requests.md +++ b/docs/user_docs/metrics/change_requests.md @@ -4,7 +4,7 @@ ## 定义 -变更请求（Change Requests）是由 [CHAOSS](https://chaoss.community) 定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - 变更请求](https://chaoss.community/kb/metric-change-requests/)。 +变更请求（Change Requests）是由 [CHAOSS](https://chaoss.community) 定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - 变更请求](https://chaoss.community/zh-CN/kb/metric-change-requests/)。 该指标是指提出的变更作为“对源代码的变更建议”进行讨论，而不是直接提交到代码库，每个变更请求都需要由其他开发人员（或维护人员）进行审查，他们可能会建议改进，从而产生新版本，直到审查为正面并接受代码，或者建议被拒绝。变更请求是项目活动的一个代理指标。但需要注意的是，这个指标不是唯一用于跟踪编码活动量的指标。 diff --git a/docs/user_docs/metrics/change_requests_accepted.md b/docs/user_docs/metrics/change_requests_accepted.md index 078a23b..ed4c5ed 100644 --- a/docs/user_docs/metrics/change_requests_accepted.md +++ b/docs/user_docs/metrics/change_requests_accepted.md @@ -4,7 +4,7 @@ ## 定义 -接受的变更请求（Change Request Accepted）是由 [CHAOSS](https://chaoss.community) 定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - 接受的变更请求](https://chaoss.community/kb/metric-change-requests-accepted/)。 +接受的变更请求（Change Request Accepted）是由 [CHAOSS](https://chaoss.community) 定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - 接受的变更请求](https://chaoss.community/zh-CN/kb/metric-change-requests-accepted/)。 该指标是项目中编码活动量的一个有价值的指示器。通过跟踪已接受的变更请求数量，我们可以获得对开发团队整体生产力和参与度的洞察。该指标作为导致项目实际变化的活动水平的代理。 diff --git a/docs/user_docs/metrics/change_requests_age.md b/docs/user_docs/metrics/change_requests_age.md index 52faf88..3f91a48 100644 --- a/docs/user_docs/metrics/change_requests_age.md +++ b/docs/user_docs/metrics/change_requests_age.md @@ -4,7 +4,7 @@ ## 定义 -变更请求年龄（Change Request Age）是由 [CHAOSS](https://chaoss.community) 定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - 问题年龄](https://chaoss.community/kb/metric-issue-age/)。 +变更请求年龄（Change Request Age）是由 [CHAOSS](https://chaoss.community) 定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - 问题年龄](https://chaoss.community/zh-CN/kb/metric-issue-age/)。 该指标衡量变更请求被保持开放的时间长度，提供了对审查和集成过程及时性的洞察。该指标对于理解开发团队的效率和响应能力至关重要。 diff --git a/docs/user_docs/metrics/change_requests_resolution_duration.md b/docs/user_docs/metrics/change_requests_resolution_duration.md index 6b65046..4b82726 100644 --- a/docs/user_docs/metrics/change_requests_resolution_duration.md +++ b/docs/user_docs/metrics/change_requests_resolution_duration.md @@ -4,7 +4,7 @@ ## 定义 -变更请求解决持续时间（Change Request Resolution Duration）是由 [CHAOSS](https://chaoss.community)定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - 变更请求解决持续时间](https://chaoss.community/metric-issue-resolution-duration/)。 +变更请求解决持续时间（Change Request Resolution Duration）是由 [CHAOSS](https://chaoss.community)定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - 变更请求解决持续时间](https://chaoss.community/zh-CN/kb/metric-issue-resolution-duration/)。 该指标衡量变更请求被关闭所需的平均时间，提供了对审查和集成过程效率和及时性的洞察。该指标对于理解开发团队的整体响应能力和效率至关重要。 diff --git a/docs/user_docs/metrics/change_requests_response_time.md b/docs/user_docs/metrics/change_requests_response_time.md index d6e1f6e..c0722ef 100644 --- a/docs/user_docs/metrics/change_requests_response_time.md +++ b/docs/user_docs/metrics/change_requests_response_time.md @@ -4,7 +4,7 @@ ## 定义 -变更请求响应时间（Change Request Response Time）是由 [CHAOSS](https://chaoss.community) 定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - 变更请求响应时间](https://chaoss.community/kb/metric-issue-response-time/)。 +变更请求响应时间（Change Request Response Time）是由 [CHAOSS](https://chaoss.community) 定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - 变更请求响应时间](https://chaoss.community/zh-CN/kb/metric-issue-response-time/)。 该指标衡量从提交变更请求到收到其他贡献者的首次响应之间的时间。这对于理解开发社区的响应能力和审查过程的效率至关重要。 diff --git a/docs/user_docs/metrics/code_changes_lines.md b/docs/user_docs/metrics/code_changes_lines.md new file mode 100644 index 0000000..c07101a --- /dev/null +++ b/docs/user_docs/metrics/code_changes_lines.md @@ -0,0 +1,31 @@ +# 代码更改行 + +![From](https://img.shields.io/badge/来自-CHAOSS-blue) ![For](https://img.shields.io/badge/用于-仓库-blue) + +## 定义 + +代码变更行（Code Changes Lines）是由 [CHAOSS 社区](https://chaoss.community) 定义的一个指标。有关此指标的详细定义，请参考 [CHAOSS 指标 - 代码变更行](https://chaoss.community/zh-CN/kb/metric-code-changes-lines/)。 + +代码变更行指标考虑了在某个时期内对源代码进行的变更所触及的行数的总和。这意味着如果某个文件中的某一行在三次不同的变更中被触及，则会计为三行。由于在大多数源代码管理系统中很难或无法准确判断某一行是被删除后再添加，还是仅被编辑，我们将编辑一行视为删除它并稍后用新内容添加回来。每一项（删除和添加）都将被视为“触及”。因此，如果某个文件中的某一行被编辑三次，则会计为六次不同的变更（三次删除和三次添加）。 + +> 代码变更行指标提供了代码变更量的洞察，有助于了解维护和开发源代码所涉及的活动和工作量。 + +## 数据 + +- **链接 (添加)：** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/code_change_lines_add.json` +- **链接 (删除)：** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/code_change_lines_remove.json` +- **链接 (总和)：** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/code_change_lines_sum.json` + +要获取某个仓库的数据，请将 `{platform}`、`{owner}` 和 `{repo}` 替换为实际名称。对于`代码添加`，请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/code_change_lines_add.json)。类似地，对于`代码删除`，请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/code_change_lines_remove.json)，对于`代码变更总和`，请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/code_change_lines_sum.json)。 + +## 代码 + +这是 [**实现代码**](https://github.com/X-lab2017/open-digger/blob/master/src/metrics/chaoss.ts#L94)。 + +## CodePen 演示 + + diff --git a/docs/user_docs/metrics/contributor_absence_factor.md b/docs/user_docs/metrics/contributor_absence_factor.md index c305bad..ddd0c71 100644 --- a/docs/user_docs/metrics/contributor_absence_factor.md +++ b/docs/user_docs/metrics/contributor_absence_factor.md @@ -4,7 +4,7 @@ ## 定义 -贡献者缺席因素（Contributor Absence Factor），是由 [CHAOSS 社区](https://chaoss.community) 定义的一个指标。有关该指标的详细定义，请参阅 [CHAOSS Metrics - Bus Factor](https://chaoss.community/zh-CN/kb/metric-contributor-absence-factor/)。 +贡献者缺席因素（Contributor Absence Factor）是由 [CHAOSS 社区](https://chaoss.community) 定义的一个指标。有关该指标的详细定义，请参阅 [CHAOSS Metrics - Bus Factor](https://chaoss.community/zh-CN/kb/metric-contributor-absence-factor/)。 贡献者缺席因素是一个引人注目的指标，因为它形象的表达了一个问题，即：“在项目停滞之前，我们可以失去多少贡献者？”。贡献者缺席因素的计算是项目贡献量 50% 的最少人数，并表明了项目失去关键贡献者（包括维护者）后的韧性程度。 diff --git a/docs/user_docs/metrics/contributors.md b/docs/user_docs/metrics/contributors.md new file mode 100644 index 0000000..a246961 --- /dev/null +++ b/docs/user_docs/metrics/contributors.md @@ -0,0 +1,30 @@ +# 贡献者 + +![From](https://img.shields.io/badge/来自-CHAOSS-blue) ![For](https://img.shields.io/badge/用于-仓库-blue) + +## 定义 + +贡献者（Contributors）是由 [CHAOSS 社区](https://chaoss.community) 定义的一个指标。有关此指标的详细定义，请参考 [CHAOSS 指标 - 贡献者](https://chaoss.community/zh-CN/kb/metric-contributors)。 + +在 OpenDigger 中，贡献者被定义为对该仓库有 PR 提交并合入的账号。OpenDigger 并未考虑直接 commit 的情况，因为这会导致贡献者数量统计出现偏差。 + +> 贡献者是理解项目健康状况的关键指标。他们是项目的生命线，他们的贡献使项目取得成功。 + +## 数据 + +- **链接 (基础)：** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/contributors.json` +- **链接 (详情)：** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/contributors_detail.json` + +要获取某个仓库的数据，请将 `{platform}`、`{owner}` 和 `{repo}` 替换为实际名称。对于基础变体，请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/contributors.json)，对于详情数据，请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/contributors_detail.json)。 + +## 代码 + +这是 [**实现代码**](https://github.com/X-lab2017/open-digger/blob/master/src/metrics/chaoss.ts#L835)。 + +## CodePen 演示 + + diff --git a/docs/user_docs/metrics/inactive_contributors.md b/docs/user_docs/metrics/inactive_contributors.md index 5c857fc..b50e09e 100644 --- a/docs/user_docs/metrics/inactive_contributors.md +++ b/docs/user_docs/metrics/inactive_contributors.md @@ -4,7 +4,7 @@ ## 定义 -不活跃的贡献者（Inactive Contributors）是由 [CHAOSS](https://chaoss.community) 定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - Inactive Contributors](https://chaoss.community/kb/metric-inactive-contributors/)。 +不活跃的贡献者（Inactive Contributors）是由 [CHAOSS](https://chaoss.community) 定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - Inactive Contributors](https://chaoss.community/zh-CN/kb/metric-inactive-contributors/)。 非活跃贡献者是一个指标，显示在特定时间段内已经停止贡献的贡献者数量。决定贡献者被认为非活跃所需的时间段可以由变量决定（默认为 6 个月），并且该指标将显示在给定时间范围内被标记为非活跃的贡献者数量。 diff --git a/docs/user_docs/metrics/issue_age.md b/docs/user_docs/metrics/issue_age.md new file mode 100644 index 0000000..7c93acb --- /dev/null +++ b/docs/user_docs/metrics/issue_age.md @@ -0,0 +1,29 @@ +# 问题年龄 + +![From](https://img.shields.io/badge/来自-CHAOSS-blue) ![For](https://img.shields.io/badge/用于-仓库-blue) + +## 定义 + +问题年龄（Issue Age）是由 [CHAOSS 社区](https://chaoss.community) 定义的一个指标。有关此指标的详细定义，请参考 [CHAOSS 指标 - 问题年龄](https://chaoss.community/zh-CN/kb/metric-issue-age)。 + +此指标是指在所考虑的时间段内问题被保持开放的时间长度。如果一个问题在该时间段内被关闭但又重新打开，则将其视为自初次打开日期起一直保持开放。这有助于了解问题未解决的持续时间，提供了关于项目内问题解决过程效率的洞察。通过跟踪开放问题的年龄，项目维护者可以识别最老的开放问题，并了解它们为什么保持开放了很长时间。这有助于了解维护者如何解决问题以及问题解决的速度。 + +> 问题年龄指标提供了关于项目内问题解决过程效率的宝贵洞察。通过识别最老的开放问题，项目维护者可以更好地了解问题解决时间长的原因，并采取适当的行动来解决它们。 + +## 数据 + +**链接：** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/issue_age.json` + +要获取某个仓库的数据，请将 `{platform}`、`{owner}` 和 `{repo}` 替换为实际名称。更多信息请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/issue_age.json)。 + +## 代码 + +这是 [**实现代码**](https://github.com/X-lab2017/open-digger/blob/master/src/metrics/chaoss.ts#L426)。 + +## CodePen 演示 + + diff --git a/docs/user_docs/metrics/issue_closed.md b/docs/user_docs/metrics/issue_closed.md new file mode 100644 index 0000000..79a20b2 --- /dev/null +++ b/docs/user_docs/metrics/issue_closed.md @@ -0,0 +1,29 @@ +# 已关闭的问题 + +![From](https://img.shields.io/badge/来自-CHAOSS-blue) ![For](https://img.shields.io/badge/用于-仓库-blue) + +## 定义 + +已关闭的问题（Issues Closed）是由 [CHAOSS 社区](https://chaoss.community) 定义的一个指标。有关此指标的详细定义，请参考 [CHAOSS 指标 - 已关闭的问题](https://chaoss.community/zh-CN/kb/metric-issues-closed)。 + +此指标跟踪在某个时期内关闭的问题数量。关闭的问题是那些在某个时期内状态变为“关闭”的问题。在某些情况或某些项目中，有其他状态或标签可以被视为“关闭”。例如，在某些项目中，他们使用状态或标签“已修复”来表示问题已关闭，即使它需要一些正式的关闭操作。 + +> 已关闭的问题指标提供了项目中处理问题的数量的洞察。关闭的问题是项目活动的一种形式，通过计算与代码相关的关闭问题数量，可以了解项目中完成问题工作的总体活动情况。当然，这个指标不是唯一用于跟踪编码活动量的指标。 + +## 数据 + +**链接：** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/issues_closed.json` + +要获取某个仓库的数据，请将 `{platform}`、`{owner}` 和 `{repo}` 替换为实际名称。更多信息请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/issues_closed.json)。 + +## 代码 + +这是 [**实现代码**](https://github.com/X-lab2017/open-digger/blob/master/src/metrics/chaoss.ts#L193)。 + +## CodePen 演示 + + diff --git a/docs/user_docs/metrics/issue_new.md b/docs/user_docs/metrics/issue_new.md new file mode 100644 index 0000000..bbfb846 --- /dev/null +++ b/docs/user_docs/metrics/issue_new.md @@ -0,0 +1,29 @@ +# 新问题 + +![From](https://img.shields.io/badge/来自-CHAOSS-blue) ![For](https://img.shields.io/badge/用于-仓库-blue) + +## 定义 + +新问题（Issues New）是由 [CHAOSS 社区](https://chaoss.community) 定义的一个指标。有关此指标的详细定义，请参考 [CHAOSS 指标 - 新问题](https://chaoss.community/zh-CN/kb/metric-issues-new)。 + +新问题指标跟踪在某个时期内创建的新问题数量。项目在问题跟踪系统中讨论如何修复错误或添加新功能。每个问题都由某个人提交（打开），并由其他人进行评论和注释。问题还可以在某些系统中与里程碑、分支、其他问题、变更请求等相关联。在某些情况下，重新打开问题可能被视为打开新问题。 + +> 新问题指标提供了项目中讨论问题的数量的洞察。问题是项目活动的一种重要形式，通过计算讨论代码的问题数量，可以了解项目中讨论问题的总体活动情况。当然，这个指标不是唯一用于跟踪编码活动量的指标。 + +## 数据 + +**链接：** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/issues_new.json` + +要获取某个仓库的数据，请将 `{platform}`、`{owner}` 和 `{repo}` 替换为实际名称。更多信息请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/issues_new.json)。 + +## 代码 + +这是 [**实现代码**](https://github.com/X-lab2017/open-digger/blob/master/src/metrics/chaoss.ts#L128)。 + +## CodePen 演示 + + diff --git a/docs/user_docs/metrics/issue_resolution_duration.md b/docs/user_docs/metrics/issue_resolution_duration.md index b7da708..7783821 100644 --- a/docs/user_docs/metrics/issue_resolution_duration.md +++ b/docs/user_docs/metrics/issue_resolution_duration.md @@ -4,7 +4,7 @@ ## 定义 -问题解决持续时间 (Issue Resolution Duration)，也称为 Issue 解决时间 (Time to Issue Resolution)，是一个由 [CHAOSS](https://chaoss.community) 定义的指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - Time to Issue Resolution](https://chaoss.community/kb/metric-issue-resolution-duration/)。 +问题解决持续时间 (Issue Resolution Duration)，也称为 Issue 解决时间 (Time to Issue Resolution)，是一个由 [CHAOSS](https://chaoss.community) 定义的指标，有关该指标的详细定义，请参阅 [CHAOSS 指标 - 问题解决持续时间](https://chaoss.community/zh-CN/kb/metric-issue-resolution-duration/)。 该指标有助于表明解决问题所需的时间，从问题开启到关闭的平均时间。这个指标可用于确定社区如何快速响应问题以及解决问题所需的时间。 diff --git a/docs/user_docs/metrics/issue_response_time.md b/docs/user_docs/metrics/issue_response_time.md index 53067ad..c8a108d 100644 --- a/docs/user_docs/metrics/issue_response_time.md +++ b/docs/user_docs/metrics/issue_response_time.md @@ -4,11 +4,11 @@ ## 定义 -问题响应时间（Issue Response Time）是由 [CHAOSS](https://chaoss.community) 定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - Issue Response Time](https://chaoss.community/metric-issue-response-time/)。 +问题响应时间（Issue Response Time）是由 [CHAOSS](https://chaoss.community) 定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS 指标 - 问题响应时间](https://chaoss.community/zh-CN/kb/metric-issue-response-time/)。 -Issue 响应时间是一个指标，显示从 Issue 开启到来自其他贡献者在该 Issue 上的响应之间经过的时间。 +问题响应时间是一个指标，显示从问题开启到来自其他贡献者在该问题上的响应之间经过的时间。 -> Issue 响应时间有助于确定社区如何快速响应 Issue。这对于社区经理确定社区是否对 Issue 做出响应和它们被解决的速度是很有用的。高 Issue 响应时间可能表明社区不响应 Issue，而低 Issue 响应时间可能表明社区会及时响应 Issue，这可用于衡量社区的整体活动水平。 +> Issue 响应时间有助于确定社区如何快速响应问题。这对于社区经理确定社区是否对问题做出响应和它们被解决的速度是很有用的。高问题响应时间可能表明社区不响应问题，而低问题响应时间可能表明社区会及时响应问题，这可用于衡量社区的整体活动水平。 ## 数据 @@ -22,7 +22,7 @@ Issue 响应时间是一个指标，显示从 Issue 开启到来自其他贡献 ## CodePen 演示 - diff --git a/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/contributors.md b/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/contributors.md new file mode 100644 index 0000000..710914a --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/contributors.md @@ -0,0 +1,33 @@ +# Contributors + +![From](https://img.shields.io/badge/From-CHAOSS-blue) ![For](https://img.shields.io/badge/For-Repo-blue) + +## Definition + +Contributors is a metric defined by the [CHAOSS community](https://chaoss.community). For a detailed definition of this metric, please refer to [CHAOSS Metrics - Contributors](https://chaoss.community/kb/metric-contributors). + +A contributor is defined as anyone who contributes to the project in any way. This metric ensures that all types of contributions are fully recognized in the project. + +> Contributors are a key metric for understanding the health of a project. They are the lifeblood of a project, and their contributions are what make the project successful. + + +## Data + +- **Link (base):** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/contributors.json` +- **Link (detail):** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/contributors_detail.json` + + +To get the data for a certain repository, replace `{platform}`, `{owner}` and `{repo}` with the actual name. For the base variant, here is an [example](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/contributors.json), and for the detailed variant, refer to this [example](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/contributors_detail.json). + +## Code + +Here's the [**implementation code**](https://github.com/X-lab2017/open-digger/blob/master/src/metrics/chaoss.ts#L835). + + +## CodePen Demo + + diff --git a/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_age.md b/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_age.md new file mode 100644 index 0000000..aa05e37 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_age.md @@ -0,0 +1,32 @@ +# Issue Age + +![From](https://img.shields.io/badge/From-CHAOSS-blue) ![For](https://img.shields.io/badge/For-Repo-blue) + +## Definition + +Issue Age is a metric defined by the [CHAOSS community](https://chaoss.community). For a detailed definition of this metric, please refer to [CHAOSS Metrics - Issue Age](https://chaoss.community/kb/metric-issue-age). + +This metric is an indication of how long issues have been left open in the considered time period. If an issue has been closed but re-opened again within that period, it will be considered as having remained open since its initial opening date. This helps in understanding the duration for which issues have remained unresolved, providing insights into the efficiency of issue resolution processes within a project. By tracking the age of open issues, project maintainers can identify the oldest open issues and gain insights into why they have been open for an extended period of time. This can help in understanding how well maintainers are resolving issues and how quickly issues are resolved. + +> The Issue Age metric provides valuable insights into the efficiency of issue resolution processes within a project. By identifying the oldest open issues, project maintainers can better understand the reasons behind prolonged issue resolution times and take appropriate actions to address them. + + +## Data + +**Link:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/issue_age.json` + +To get the data for a certain repository, replace `{platform}`, `{owner}` and `{repo}` with the actual name. For more, refer to this [example](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/issue_age.json). + + +## Code + +Here's the [**implementation code**](https://github.com/X-lab2017/open-digger/blob/master/src/metrics/chaoss.ts#L426). + + +## CodePen Demo + + diff --git a/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_closed.md b/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_closed.md new file mode 100644 index 0000000..a32f004 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_closed.md @@ -0,0 +1,34 @@ +# Issue Closed + +![From](https://img.shields.io/badge/From-CHAOSS-blue) ![For](https://img.shields.io/badge/For-Repo-blue) + +## Definition + +Issue Closed is a metric defined by the [CHAOSS community](https://chaoss.community). For a detailed definition of this metric, please refer to [CHAOSS Metrics - Issues Closed](https://chaoss.community/kb/metric-issues-closed). + +This metric tracks the number of issues that were closed during a certain period. Issues closed are those that changed to the state "closed" during a certain period. In some cases or some projects, there are other states or tags that could be considered as "closed". For example, in some projects, they use the state or the tag "fixed" to indicate that the issue is closed, even when it needs some action for formally closing it. + +In some cases, some of these are also issues themselves. Reopening an issue might be considered as opening a new issue in certain scenarios. + +> The Issues Closed metric provides insights into the volume of issues that are dealt with in a project. Closed issues are a proxy for the activity in a project. By counting closed issues related to code in the set of repositories corresponding to a project, you can have an idea of the overall activity in finishing work with issues in that project. Of course, this metric is not the only one that should be used to track the volume of coding activity. + + +## Data + +**Link:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/issues_closed.json` + +To get the data for a certain repository, replace `{platform}`, `{owner}` and `{repo}` with the actual name. For more, refer to this [example](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/issues_closed.json). + + +## Code + +Here's the [**implementation code**](https://github.com/X-lab2017/open-digger/blob/master/src/metrics/chaoss.ts#L193). + + +## CodePen Demo + + diff --git a/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_new.md b/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_new.md new file mode 100644 index 0000000..7b3b89f --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_new.md @@ -0,0 +1,32 @@ +# Issues New + +![From](https://img.shields.io/badge/From-CHAOSS-blue) ![For](https://img.shields.io/badge/For-Repo-blue) + +## Definition + +Issues New is a metric defined by the [CHAOSS community](https://chaoss.community). For a detailed definition of this metric, please refer to [CHAOSS Metrics - Issues New](https://chaoss.community/kb/metric-issues-new). + +The Issues New metric tracks the number of new issues created during a certain period. Projects discuss how they are fixing bugs, or adding new features, in tickets in the issue tracking system. Each of these tickets (issues) is opened (submitted) by a certain person and is later commented and annotated by many others. Issues can also be, in some systems, associated with milestones, branches, epics, or stories. In some cases, some of these are also issues themselves. Reopening an issue might be considered as opening a new issue in certain scenarios. + +> The Issues New metric provides insights into the volume of issues discussed in a project. Issues are a proxy for the activity in a project. By counting issues discussing code in the set of repositories corresponding to a project, one can have an idea of the overall activity in discussing issues in that project. Of course, this metric is not the only one that should be used to track volume of coding activity. + + +## Data + +**Link:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/issues_new.json` + +To get the data for a certain repository, replace `{platform}`, `{owner}` and `{repo}` with the actual name. For more, refer to this [example](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/issues_new.json). + + +## Code + +Here's the [**implementation code**](https://github.com/X-lab2017/open-digger/blob/master/src/metrics/chaoss.ts#L128). + + +## CodePen Demo + + diff --git a/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_response_time.md b/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_response_time.md index acc7c70..d16b6fc 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_response_time.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/issue_response_time.md @@ -25,8 +25,8 @@ Here's the [**implementation code**](https://github.com/X-lab2017/open-digger/bl ## CodePen Demo - diff --git a/sidebars.js b/sidebars.js index 57b40db..aebf059 100644 --- a/sidebars.js +++ b/sidebars.js @@ -15,7 +15,6 @@ const sidebars = { userDocSidebar: [ 'user_docs/intro', - 'user_docs/playground', { type: 'category', label: 'data_sources', @@ -32,6 +31,7 @@ const sidebars = { collapsed: false, items: [ 'user_docs/metrics/how_to_use', + 'user_docs/metrics/playground', { type: 'category', label: 'openrank', @@ -57,6 +57,7 @@ const sidebars = { collapsed: true, items: [ 'user_docs/metrics/new_contributors', + 'user_docs/metrics/contributors', 'user_docs/metrics/inactive_contributors', 'user_docs/metrics/contributor_absence_factor', ], @@ -66,8 +67,11 @@ const sidebars = { label: 'issues', collapsed: true, items: [ + 'user_docs/metrics/issue_new', + 'user_docs/metrics/issue_closed', 'user_docs/metrics/issue_response_time', 'user_docs/metrics/issue_resolution_duration', + 'user_docs/metrics/issue_age', ], }, { @@ -81,6 +85,7 @@ const sidebars = { 'user_docs/metrics/change_requests_response_time', 'user_docs/metrics/change_requests_resolution_duration', 'user_docs/metrics/change_requests_age', + 'user_docs/metrics/code_changes_lines', ], }, ], diff --git a/src/css/custom.css b/src/css/custom.css index 93a4437..b81c368 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -5,7 +5,6 @@ */ /* You can override the default Infima variables here. */ - :root { --ifm-color-primary: #3366FF; --ifm-color-primary-dark: #144fff; @@ -14,10 +13,6 @@ --ifm-color-primary-light: #527dff; --ifm-color-primary-lighter: #6188ff; --ifm-color-primary-lightest: #89a6ff; - --ifm-table-border-width: 0; - --ifm-table-stripe-background: #fff; - --ifm-table-border-color: #fff; - --ifm-table-cell-padding: 0.5rem; --ifm-code-font-size: 95%; --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); --banner-height: 40px; @@ -124,16 +119,22 @@ iframe { details { border: 1px solid #ccc; border-radius: 4px; - transition: all 0.3s ease; + transition: all 1.3s ease; padding: 0.5em; + transform: scale(1); +} + +details:not([open]):hover { + transform: scale(1.02); + background-color: #362ecc74; } summary { font-weight: bold; cursor: pointer; position: relative; - padding-right: 20px; - list-style: none; + padding-right: 20px; + list-style: none; } summary::-webkit-details-marker { @@ -141,23 +142,23 @@ summary::-webkit-details-marker { } summary::after { - content: '❯'; + content: '❯'; position: absolute; right: 0; top: 50%; - transform: translateY(-50%); + transform: translateY(-50%) rotate(90deg); transition: transform 0.3s ease; } details[open] summary::after { - transform: translateY(-50%) rotate(90deg); + transform: translateY(-50%) rotate(270deg); } details:not([open]):hover { background-color: #362ecc74; } -details > *:not(summary) { +details>*:not(summary) { margin-top: 0.5em; } @@ -170,11 +171,10 @@ table { vertical-align: middle; } - table a { color: #0477eb; text-decoration: none; - transition: color 0.3s ease; + transition: color 0.25s ease; } table a:hover { @@ -188,9 +188,15 @@ table a:hover { border-radius: 12px; box-shadow: 4px 4px 0 #050137; box-sizing: border-box; + transition: transform 0.1s ease; } +/* #elevatedbtn:hover { + transform: scale(1.01); +} */ + /* Redundant since #ID is unique and is mounted for CN (default) and NOT for EN on mount */ + #elevatedbtnEN { font-family: Archivo Black; border: 4px solid #050137;