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

Merge branch 'master' of https://github.com/lowlighter/metrics

Browse Source
This commit is contained in:
lowlighter
2020-11-02 22:35:11 +01:00
parent e24d2d8482 88fbc7ae41
commit 72c95fcbfd
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -15,12 +15,14 @@ To use [GitHub Rest API](https://docs.github.com/en/rest) or a third-party servi
Plugins should be self-sufficient and re-exported from [src/plugins/index.mjs](https://github.com/lowlighter/metrics/blob/master/src/plugins/index.mjs), to be later included in the `//Plugins` section of `templates/*/template.mjs`. Plugins should be self-sufficient and re-exported from [src/plugins/index.mjs](https://github.com/lowlighter/metrics/blob/master/src/plugins/index.mjs), to be later included in the `//Plugins` section of `templates/*/template.mjs`.
Data generated should be exposed in `data.computed.plugins[plugin]` where `plugin` is your plugin's name. Data generated should be exposed in `data.computed.plugins[plugin]` where `plugin` is your plugin's name.
#### Updating the SVG template #### Updating SVG templates
The SVG template is located in `templates/*/image.svg` and include the CSS from `templates/*/style.css`. The SVG templates are located in `templates/*/image.svg` and include CSS from `templates/*/style.css`.
It is rendered with [EJS](https://github.com/mde/ejs) so you can actually include variables (e.g. `<%= user.name %>`) and execute simple code, like control statements. It is rendered with [EJS](https://github.com/mde/ejs) so you can actually include variables (e.g. `<%= user.name %>`) and execute simple code, like control statements.
It should handle plugins errors gracefully by displaying the error message.
#### Metrics server and GitHub action #### Metrics server and GitHub action
Most of the time, you won't need to edit these, unless you're integrating features directly tied to them. Most of the time, you won't need to edit these, unless you're integrating features directly tied to them.