@@ -229,17 +229,17 @@ Do not include the same information in multiple places. [Link to a SSOT instead.
Some features are also objects. For example, "GitLab's Merge Requests support X." and
"Create a new merge request for Z.".
- Avoid use of the future tense.
- Avoid use of the future tense:
- Instead of, "After you execute this command, the result will be displayed," say "After you execute this command, the result is displayed."
- Only use the future tense to convey when the action or result will actually occur at a future time.
- Do not use contractions.
- Do not use contractions:
- Instead of "don't", "can't", "doesn't", and so on, say "do not", "cannot", or "does not."
- Possible exceptions are cases when a more familiar tone is desired, such as a blog post or other casual context.
- Do not use slashes to clump different words together or as a replacement for the word "or."
- Do not use slashes to clump different words together or as a replacement for the word "or":
- Instead of "and/or", consider saying "or", or use another sensible construction.
- Other examples include "clone/fetch," author/asignee," and "namespace/repository name." Break apart any such instances in an appropriate way.
- Exceptions to this rule include commonly accepted technical terms such as CI/CD, TCP/IP, and so on.
- Do not use "may" and "might" interchangeably.
- Do not use "may" and "might" interchangeably:
- Use "might" to indicate the probability of something occurring. "If you skip this step, the import process might fail."
- Use "may" to indicate giving permission for someone to do something, or consider using "can", instead. "You may select either option on this screen." Or, "you can select either option on this screen."
