Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
0fefaad5
Commit
0fefaad5
authored
Aug 10, 2021
by
Nick Gaskill
Committed by
Suzanne Selhorn
Aug 10, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add need to and should to docs word list
parent
8d32b156
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
15 additions
and
0 deletions
+15
-0
doc/development/documentation/styleguide/word_list.md
doc/development/documentation/styleguide/word_list.md
+15
-0
No files found.
doc/development/documentation/styleguide/word_list.md
View file @
0fefaad5
...
...
@@ -254,6 +254,21 @@ Lowercase. If you use **MR** as the acronym, spell it out on first use.
Lowercase.
## need to, should
Try to avoid. If something is required, use
**must**
.
-
Avoid: You need to set the variable.
-
Use instead: You must set the variable. Or: Set the variable.
**Should**
is acceptable for recommended actions or items, or in cases where an event may not
happen. For example:
-
Although you can configure the installation manually, you should use the express configuration to
avoid complications.
-
You should see a success message in the console. Contact support if an error message appears
instead.
## note that
Do not use.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment