[SQ] Linked to SQ in README, more info on SQ voter

cs-soc-tudublin · Aug 12, 2024 · ab8d448 · ab8d448
1 parent 166daa6
commit ab8d448
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ This will improve the Dx as less time is required to write custom voters for eac
 Minimal modifications should be required to these voters to make them applicable to your project.
 
 ## Wave 1 Voters
-- SonarQube
+- [SonarQube](./sonarqube/)
 - Spell Check
 - File Existence Checks
 - Link Resolution Checks

diff --git a/sonarqube/README.md b/sonarqube/README.md
@@ -1,7 +1,9 @@
 # SonarQube Voter
 SonarQube is a code analysis tool that analyses the quality, format and security of code.
 
-It provides a simple 'go/no go' system, AKA the voter passes if there are no issues, and fails if there are
+It provides a simple 'go/no go' system, AKA the voter passes if there are no issues, and fails if there are.
+
+SonarQube is run on a branch, as opposed to running as a Pull Request Check, due to licensing issues.
 
 ## Configuration
 > [!NOTE]