Git designed for AI agents.
---
name: gitlab_base.SubstitutionWarning
description: |
Checks for misused terms or common shorthand that should not be used at GitLab, but can't be flagged as errors. Substitutions.yml also exists.
extends: substitution
message: "Use '%s' instead of '%s'."
link: https://docs.gitlab.com/development/documentation/styleguide/word_list/
vocab: false
level: warning
action:
name: replace
ignorecase: true
swap:
active user: "billable user"
active users: "billable users"
agnostic: "platform-independent' or 'vendor-neutral"
air(?:-| )?gapped: "offline environment"
bullet: "list item"
(?<!right-)click(?!-through): "select"
cancelled: "canceled"
cancelling: "canceling"
case sensitive: "case-sensitive"
case insensitive: "case-insensitive"
cherry pick: "cherry-pick"
cmd: Command
code base: "codebase"
config: "configuration"
confirmation box: "confirmation dialog"
confirmation dialog box: "confirmation dialog"
ctrl: Control
del: Delete
deselect: "clear"
deselected: "cleared"
dialog box: "dialog"
distro: "distribution"
docs: "documentation"
(?<!GitLab )(?<!Cisco )(?<!Fix (pipeline )?with )(?<!Generate MR with )Duo: "GitLab Duo"
DAP: "GitLab Duo Agent Platform"
e-mail: "email"
emojis: "emoji"
ex: "for example"
file name: "filename"
filesystem: "file system"
fullscreen: "full screen"
info: "information"
installation from source: self-compiled installation
installations from source: self-compiled installations
it is recommended: "you should"
log in: "sign in"
log-in: "sign in"
logged in user: "authenticated user"
logged-in user: "authenticated user"
lower case: "lowercase"
lower-case: "lowercase"
machine-learning: "machine learning"
modal dialog: "dialog"
modal window: "dialog"
modal: "dialog"
n/a: "not applicable"
navigate to: "go to"
normally: "usually' or 'typically"
normal: "typical' or 'standard"
OAuth2: "OAuth 2.0"
omnibus gitlab: "Linux package"
'omnibus(?!\)| builder)': "Linux package"
once a: "after a"
once that: "after that"
once the: "after the"
once you: "after you"
open telemetry: "OpenTelemetry"
open ldap: "OpenLDAP"
pack file: packfile
pack files: packfiles
pop-up window: "dialog"
pop-up: "dialog"
popup: "dialog"
primary node: "primary site"
re-index: "reindex"
repo: "repository"
root group: "top-level group"
secondary node: "secondary site"
signed in user: "authenticated user"
signed-in user: "authenticated user"
since: "because' or 'after"
source (?:install|installation): self-compiled installation
source (?:installs|installations): self-compiled installations
sub directories: "subdirectories"
sub-directories: "subdirectories"
sub directory: "subdirectory"
sub-directory: "subdirectory"
sub group: "subgroup"
sub-group: "subgroup"
sub-groups: "subgroups"
timezone: "time zone"
top level group: "top-level group"
utiliz(?:es?|ing): "use"
VSCode: "VS Code"
WebIDE: "Web IDE"
we recommend: "you should"
within: "in"