summaryrefslogtreecommitdiff
path: root/doc/.vale/gitlab/ToDo.yml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/.vale/gitlab/ToDo.yml')
-rw-r--r--doc/.vale/gitlab/ToDo.yml14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/.vale/gitlab/ToDo.yml b/doc/.vale/gitlab/ToDo.yml
new file mode 100644
index 00000000000..b3c5f6077b1
--- /dev/null
+++ b/doc/.vale/gitlab/ToDo.yml
@@ -0,0 +1,14 @@
+---
+# Warning: gitlab.ToDo
+#
+# You should not use "To Do", unless it refers to the UI element.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: substitution
+message: 'Use "to-do item" in most cases, or "Add a to do" if referring to the UI button.'
+link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#feature-names
+level: warning
+ignorecase: false
+swap:
+ '[Tt]o [Dd]o [Ii]tems?': to-do item
+ '\w* [Aa] [Tt]o [Dd]o': Add a to do