Use faker.js for mocked data and placeholder (#47)

2021-01-14 18:29:27 +01:00
parent c34e73fa68
commit d6e28e17bf
19 changed files with 1385 additions and 1070 deletions
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,35 +1,40 @@
 <!--
-  Thank you very much for contributing to this repository !

-  Link any related issues (if applicable) to help us keeping track of this project current state.
-  Don't forget to run `npm run test` to ensure that you'll pass status checks validation.
+  👋 Hi there!
+  Thanks for contributing to metrics and helping us to improve!
+
+  Please check the following before opening a pull request:
+    - It does not duplicate another existing pull request
+    - It is not mentioned in https://github.com/lowlighter/metrics/projects/1
+      - If it is, ensure that maintainers are aware that you're working on this subject
+
+  Then, explain briefly what your pull request is about and link any related issues (if applicable) to help us keeping track.
+
+  For documentation updates....
+    - Check spelling before asking for a review
+    - Respect current formatting (check that your editions blends well with current state)
+    - Static images must be saved in /.github/readme/imgs and must be of width 1260px
+      - UI should always be set in English in screenshots
+
+  For new plugins...
+    - Ensure that you created:
+      - a plugin entrypoint named index.mjs in /source/plugins
+      - tests in /tests/metrics.test.js
+        - mocked data if needed (required for all APIs which requires a token or limited in requests)
+    - Ensure you updated:
+      - /source/app/action/index.mjs to support new plugin options and use correct typing
+      - /source/web/statics/* to support new plugin options
+      - /settings.example.json with new plugin name
+      - README.md to explain new plugin features
+    - Include a screenshot in your pull request description
+      - You can use `&config.output=png` option in your web instance for it
+
+  For all code editions...
+    - Ensure retro-compatibility with previous versions (
+        - (unless for unreleased features, for which breaking changes are allowed)
+    - Respect current formatting
+      - Prefers using appropriate single words for variables and plugins names
+      - Avoid using uppercases letters, brackets and semicolons when possible to avoid visual pollution
+      - Comments should be added before each "code paragraph" and are considered indent worthy
+
 -->
-
-**Pull request description**
-<!--
-  A clear and concise description of what your pull request implements or fixs.
-
-  Please check the following:
-
-    > Documentation update
-      - Check spelling
-      - Respect current formatting
-
-    > New plugin
-      - Created new plugin in /source/plugins/ with index.mjs as entry point
-      - Added tests in /tests/metrics.test.js
-        - Added mocked data if needed (required for all APIs which requires a token or limited in requests)
-      - Updated action.yml with new plugin options
-        - Updated /source/app/action/index.mjs to retrieve plugin options with correct typing
-        - Updated /source/web/statics/* to support new plugin options
-        - Updated /settings.example.json with new plugin name
-      - Updated README.md to explain plugin features
-
-    > Code editions
-      - Ensure retro-compatibility with previous versions
-        - Unless feature is not released yet
-      - Respect current formatting
-->
-
-**Additional context and screenshots**
-<!-- Add any other context or screenshots about your pull request here. -->