diff --git a/source/plugins/followup/README.md b/source/plugins/followup/README.md
index 22817edb..f732720a 100644
--- a/source/plugins/followup/README.md
+++ b/source/plugins/followup/README.md
@@ -1,23 +1,30 @@
-### đī¸ Follow-up of issues and pull requests
-
-The *followup* plugin displays the ratio of open/closed issues and the ratio of open/merged pull requests across all your repositories, which shows if they're well-maintained or not.
-
+
+
-#### âĄī¸ Available options
+## âĄī¸ Available options
@@ -26,7 +33,7 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of
plugin_followup |
- Display follow-up of repositories issues and pull requests
+ | Enable followup plugin
![]() |
@@ -36,7 +43,11 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of
plugin_followup_sections |
- Sections to display
+ | Displayed sections
+
+repositories: overall status of issues and pull requests on your repositories
+user: overall status of issues and pull requests you have created on GitHub
+
![]() |
@@ -48,7 +59,7 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of
plugin_followup_indepth |
- Indepth follow-up processing
+ | Indepth analysis
![]() |
@@ -60,9 +71,13 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of
-*[â Full specification](metadata.yml)*
+## đ `indepth` mode
-#### âšī¸ Examples workflows
+The `plugin_followup_indepth` option collects additional stats to differentiate issues and pull requests opened by maintainers and users.
+
+It helps knowing whether repositories are also maintained by other users and give an overall health status of repositories.
+
+## âšī¸ Examples workflows
```yaml
@@ -97,4 +112,4 @@ with:
plugin_followup_indepth: 'yes'
```
-
\ No newline at end of file
+
diff --git a/source/plugins/followup/metadata.yml b/source/plugins/followup/metadata.yml
index ded71d96..a89bd37a 100644
--- a/source/plugins/followup/metadata.yml
+++ b/source/plugins/followup/metadata.yml
@@ -1,5 +1,10 @@
name: "đī¸ Follow-up of issues and pull requests"
category: github
+description: This plugin displays the ratio of open/closed issues and the ratio of open/merged pull requests across all your repositories.
+examples:
+ +indepth analysis: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.followup.indepth.svg
+ created on an user's repositories: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.followup.svg
+ created by an user: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.followup.user.svg
index: 7
supports:
- user
@@ -9,25 +14,25 @@ scopes:
- public_access
inputs:
- # Enable or disable plugin
plugin_followup:
- description: Display follow-up of repositories issues and pull requests
+ description: Enable followup plugin
type: boolean
default: no
- # Sections to display
plugin_followup_sections:
- description: Sections to display
+ description: |
+ Displayed sections
+ - `repositories`: overall status of issues and pull requests on your repositories
+ - `user`: overall status of issues and pull requests you have created on GitHub
type: array
format: comma-separated
default: repositories
values:
- - repositories # Overall status of issues and pull requests on your repositories
- - user # Overall status of issues and pull requests you have created on GitHub
+ - repositories
+ - user
- # Compute issues and pull requests per repositories with special highlighting for maintainers and specified users
plugin_followup_indepth:
- description: Indepth follow-up processing
+ description: Indepth analysis
type: boolean
default: no
extras: yes