From d4bedda082a335c3e4520e2adc4ebd3213914b98 Mon Sep 17 00:00:00 2001 From: Diego Molina Date: Mon, 15 Jan 2024 22:33:50 +0100 Subject: [PATCH] Simplifying configuration document. [skip ci] --- HOW-TO-CONFIGURE.md | 28 +++------------------------- 1 file changed, 3 insertions(+), 25 deletions(-) diff --git a/HOW-TO-CONFIGURE.md b/HOW-TO-CONFIGURE.md index bd961444..f908fe2d 100644 --- a/HOW-TO-CONFIGURE.md +++ b/HOW-TO-CONFIGURE.md @@ -37,36 +37,14 @@ Check-My-Repo is built upon [Repolinter](https://todogroup.github.io/repolinter/ To add [see all Repolinter rules](https://github.com/todogroup/repolinter/blob/master/rulesets/default.json) please refer directly to their documentation. Check-My-Repo rules can be modified at `./repolinter.json` file in the project root. -### Changing Badges With Modified Rules - -If ou do change a rule, make sure to change your badges. - -This is the default ruleset badges, found at: `./frontend/src/components/Details.vue` - -``` - Binaries - License - Readme - Changelog - Contributing - Ownership - TestDir - CodeOfConduct - LicenseOnReadme - Security - Support -``` -Where: -- [] `item.includes` searches for the rule name specified in `repolinter.json` -- [] `high`, `medium` or `low` changes the css style of the badges - ## Changing Logo -Application uses now Sauce Labs Bot as a default logo. You can change it to yout own logo just switching the `logo.svg` file at `./frontend/public` folder. +Application uses now Sauce Labs Bot as a default logo. You can change it to your own logo just switching the `logo.svg` +file at `./frontend/public` folder. ## Checking for accessibility after modifying the application -Check-My-Repo uses [vue-axe](https://www.npmjs.com/package/vue-axe) in development mode to acessibility verification. +Check-My-Repo uses [vue-axe](https://www.npmjs.com/package/vue-axe) in development mode to accessibility verification. You can check if something is missing on your Browsers console, or disable it in `./frontend/main.js` file, by turning to `auto: false`