This is an automated email from the ASF dual-hosted git repository.
yumeng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new 1045a329 docs: fix markdown format
1045a329 is described below
commit 1045a329268d6a1f762a6507d95fc12cbe2dbf94
Author: xfkwang <[email protected]>
AuthorDate: Tue Aug 23 12:50:24 2022 +0800
docs: fix markdown format
---
docs/Metrics/CodingTime.md | 2 ++
docs/Metrics/CycleTime.md | 2 ++
docs/Metrics/DeployTime.md | 1 +
docs/Metrics/PRSize.md | 2 ++
docs/Metrics/PickupTime.md | 2 ++
docs/Metrics/ReviewDepth.md | 2 ++
docs/Metrics/ReviewTime.md | 3 +++
docs/Metrics/TimeToMerge.md | 2 ++
8 files changed, 16 insertions(+)
diff --git a/docs/Metrics/CodingTime.md b/docs/Metrics/CodingTime.md
index 915eb9a3..d7884748 100644
--- a/docs/Metrics/CodingTime.md
+++ b/docs/Metrics/CodingTime.md
@@ -18,9 +18,11 @@ It is recommended that you keep every task on a workable and
manageable scale fo
## How is it calculated?
<b>Data Sources Required</b>
+
This metric relies on PR/MRs collected from GitHub or GitLab.
<b>Transformation Rules Required</b>
+
N/A
<b>SQL Queries</b>
diff --git a/docs/Metrics/CycleTime.md b/docs/Metrics/CycleTime.md
index b2c58b92..bbc98349 100644
--- a/docs/Metrics/CycleTime.md
+++ b/docs/Metrics/CycleTime.md
@@ -20,9 +20,11 @@ PR Cycle Time indicate the overall speed of the delivery
progress in terms of PR
You can define `deployment` based on your actual practice. For a full list of
`deployment`'s definitions that DevLake support, please refer to [Deployment
Frequency](/docs/Metrics/DeploymentFrequency.md).
<b>Data Sources Required</b>
+
This metric relies on PR/MRs collected from GitHub or GitLab.
<b>Transformation Rules Required</b>
+
N/A
<b>SQL Queries</b>
diff --git a/docs/Metrics/DeployTime.md b/docs/Metrics/DeployTime.md
index 9f42aff9..d9084808 100644
--- a/docs/Metrics/DeployTime.md
+++ b/docs/Metrics/DeployTime.md
@@ -23,6 +23,7 @@ You can define `deployment` based on your actual practice.
For a full list of `d
This metric relies on PR/MRs collected from GitHub or GitLab.
<b>Transformation Rules Required</b>
+
N/A
## How to improve?
diff --git a/docs/Metrics/PRSize.md b/docs/Metrics/PRSize.md
index 284addfc..bf6a87d8 100644
--- a/docs/Metrics/PRSize.md
+++ b/docs/Metrics/PRSize.md
@@ -20,9 +20,11 @@ Small PRs can reduce risks of introducing new bugs and
increase code review qual
This metric is calculated by counting the total number of code changes (in
LOC) divided by the total number of PRs in the selected time range.
<b>Data Sources Required</b>
+
This metric relies on PR/MRs collected from GitHub or GitLab.
<b>Transformation Rules Required</b>
+
N/A
<b>SQL Queries</b>
diff --git a/docs/Metrics/PickupTime.md b/docs/Metrics/PickupTime.md
index 1a37a477..07242ae7 100644
--- a/docs/Metrics/PickupTime.md
+++ b/docs/Metrics/PickupTime.md
@@ -18,9 +18,11 @@ PR Pickup Time shows how engaged your team is in
collaborative work by identifyi
## How is it calculated?
<b>Data Sources Required</b>
+
This metric relies on PR/MRs collected from GitHub or GitLab.
<b>Transformation Rules Required</b>
+
N/A
<b>SQL Queries</b>
diff --git a/docs/Metrics/ReviewDepth.md b/docs/Metrics/ReviewDepth.md
index e9b5e7b2..59bcfbe8 100644
--- a/docs/Metrics/ReviewDepth.md
+++ b/docs/Metrics/ReviewDepth.md
@@ -19,9 +19,11 @@ PR Review Depth (in Comments per RR) is related to the
quality of code review, i
This metric is calculated by counting the total number of PR comments divided
by the total number of PRs in the selected time range.
<b>Data Sources Required</b>
+
This metric relies on PR/MRs collected from GitHub or GitLab.
<b>Transformation Rules Required</b>
+
N/A
<b>SQL Queries</b>
diff --git a/docs/Metrics/ReviewTime.md b/docs/Metrics/ReviewTime.md
index 0769c340..8cfe080b 100644
--- a/docs/Metrics/ReviewTime.md
+++ b/docs/Metrics/ReviewTime.md
@@ -20,10 +20,13 @@ Code review should be conducted almost in real-time and
usually take less than t
## How is it calculated?
This metric is the time frame between when the first comment is added to a PR,
to when the PR is merged.
+
<b>Data Sources Required</b>
+
This metric relies on PR/MRs collected from GitHub or GitLab.
<b>Transformation Rules Required</b>
+
N/A
<b>SQL Queries</b>
diff --git a/docs/Metrics/TimeToMerge.md b/docs/Metrics/TimeToMerge.md
index db86f627..04a39225 100644
--- a/docs/Metrics/TimeToMerge.md
+++ b/docs/Metrics/TimeToMerge.md
@@ -18,9 +18,11 @@ The delay of reviewing and waiting to review PRs has large
impact on delivery sp
## How is it calculated?
<b>Data Sources Required</b>
+
This metric relies on PR/MRs collected from GitHub or GitLab.
<b>Transformation Rules Required</b>
+
N/A
<b>SQL Queries</b>
