Added design vision for Wave 1 Voters

README.md

@@ -9,9 +9,9 @@ Minimal modifications should be required to these voters to make them applicable
 
 ## Wave 1 Voters
 - [SonarQube](./sonarqube/)
-- Spell Check
-- File Existence Checks
-- Link Resolution Checks
+- [Spell Check](./spell-check/)
+- [File Existence Checks](./file-existence/)
+- [Link Resolution Checks](./link-resolver/)
 
 ## Wave 2 Voters
 - Container Build Checks

file-existence/README.md

@@ -1,2 +1,7 @@
 # File Existence Voter
-TBF
+
+## Design Vision
+The file exisence voter should check that all files that are referenced actually exist in that path. This prevents broken links to files by way of typo, directory mistake or non-existing file.
+For .env or other files that should be excluded, there should be a file (maybe .gitignore?) that gives link exceptions for the voter to ignore.
+
+The voter should run during a branch push, or a PR and fail if any links fail to resolve.

link-resolver/README.md

@@ -1,2 +1,7 @@
 # Link Resolution Voter
-TBF
+
+## Design Vision
+The link resolution voter should check all files for a URL by means of a regular expression (Except for localhost URLs) and ensure they actually resolve. This prevents broken links being introduced.
+For localhost or other links that should be excluded, there should be a file that gives link exceptions for the voter to ignore.
+
+The voter should run during a branch push, or a PR and fail if any links fail to resolve.

spell-check/README.md

@@ -1,2 +1,7 @@
 # Spell Check Voter
-TBF
+
+## Design Vision
+The spell check voter should check HTML, Markdown, READMEs, etc. (any file which contains text that would be read by a user) and verify correct spelling.
+For words specfic to the project, there should be a file which gives word exceptions for the voter to ignore.
+
+The voter should run during a branch push, or a PR and fail if any typos are detected.