sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: remove cost, document missing options and improve docs (#653)

Browse Source
This commit is contained in:
Simon Lecoq
2021-11-04 19:33:29 -04:00
committed by GitHub
parent e147d2ac32
commit a291e35774
56 changed files with 82 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
source/plugins/notable/README.md
View File

@@ -5,13 +5,23 @@ The *notable* plugin displays badges of organization where you commited at least
<table>
<td align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.notable.svg">
<details open><summary>With repository name</summary>
<details><summary>With repository name</summary>
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.notable.repositories.svg">
</details>
<details open><summary>Indepth analysis</summary>
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.notable.indepth.svg">
</details>
<img width="900" height="1" alt="">
</td>
</table>
#### Using `indepth` statistics
The `plugin_notable_indepth` option lets you get additional metrics about your contribution, such as:
- Total number of commits within a repository or organization. The badge will have a circular gauge which is proportional to the percentage of total contribution. It will also determine the resulting color of the badge.
> 🔣 On web instances, `indepth` is an extra feature and must be enabled globally in `settings.json`
#### ℹ️ Examples workflows
[➡️ Available options for this plugin](metadata.yml)
@@ -21,7 +31,8 @@ The *notable* plugin displays badges of organization where you commited at least
with:
# ... other options
plugin_notable: yes
plugin_notable_filter: stars:>500 # Only display repositories with 500 stars or more (syntax based on GitHub search query)
plugin_notable_from: organization # Only display contributions within organization repositories
plugin_notable_repositories: yes # Display repositories name instead of only organization name
plugin_notable_filter: stars:>500 # Only display repositories with 500 stars or more (syntax based on GitHub search query)
plugin_notable_from: organization # Only display contributions within organization repositories
plugin_notable_repositories: yes # Display repositories name instead of only organization name
plugin_notable_indepth: yes # Gather additional informations about contributions
```

1
source/plugins/notable/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🎩 Notable contributions"
cost: 1 GraphQL request per 100 repositories fetched
category: github
index: 20
supports: