Merge pull request #25 from IBM/fh-links

Add Links rule

IBMQuantum/Links.yml

@@ -0,0 +1,16 @@
+extends: existence
+message: Link names should make sense without context; change "%s" to something more descriptive.
+level: suggestion
+code: false
+scope: link
+ignorecase: true
+tokens:
+    - click here
+    - here
+    - link
+    - more
+    - more information
+    - page
+    - read more
+    - this link
+    - this page

features/rules.feature

@@ -16,6 +16,7 @@ Feature: Rules
         test.md:27:36:IBMQuantum.Terms:Use 'use' rather than 'utilize'
         test.md:27:75:IBMQuantum.CringeWords:Don't use 'end users'
         test.md:27:90:IBMQuantum.CringeWords:Don't use 'we encourage you'
+        test.md:29:12:IBMQuantum.Links:Link names should make sense without context; change "link" to something more descriptive.
         """
 
     Scenario: Use of punctuation

fixtures/Terms/.vale.ini

@@ -8,3 +8,4 @@ IBMQuantum.Terms = YES
 IBMQuantum.CringeWords = YES
 IBMQuantum.Politeness = YES
 IBMQuantum.However = YES
+IBMQuantum.Links = YES

fixtures/Terms/test.md

@@ -25,3 +25,7 @@ This sentence is however, bad.
 Please do not be too polite in your technical writing.
 
 We understand that you may want to utilize these phrases when writing for end users, but we encourage you not to.
+
+This is a [link](www.ibm.com) to IBM's site.
+
+Check out this link to the [IBM website](www.ibm.com).