Skip to content

Commit 20ccd82

Browse files
committed
Update README.md
1 parent 4e81056 commit 20ccd82

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

source/plugins/languages/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ The `plugin_languages_indepth` option lets you get more accurate metrics by clon
3333
> ⚠️ Although *metrics* does not send any code to external sources, you must understand that when using this option repositories are cloned locally temporarly on the GitHub Action runner. If you work with sensitive data or company code, it is advised to keep this option disabled. *Metrics* cannot be held responsible for any eventual code leaks, use at your own risk.
3434
> Source code is available for auditing at [analyzers.mjs](/source/plugins/languages/analyzers.mjs)
3535
36+
#### `commits_authoring` option
37+
38+
Since Git lets you use any email and name for commits, metrics may not be able to detect whether you own a commit or not. By default, it'll check whether it matches your GitHub login.
39+
40+
For better results, it's advised to add either your surnames and eventually no-reply email addresses.
41+
3642
#### ℹ️ Examples workflows
3743

3844
[➡️ Available options for this plugin](metadata.yml)
@@ -50,4 +56,5 @@ The `plugin_languages_indepth` option lets you get more accurate metrics by clon
5056
plugin_languages_limit: 8 # Display up to 8 languages
5157
plugin_languages_sections: most-used, recently-used # Display most used and recently used languages stats
5258
plugin_languages_indepth: no # Get indepth stats (see documentation before enabling)
59+
commits_authoring: lowlighter@users.noreply.github.com # Surnames or email addresses used to identify your commits
5360
```

0 commit comments

Comments
 (0)