Skip to content

Add style guide rules to tests, cross-link

Amy Qualls requested to merge aqualls-various-rules into master

What does this MR do?

While proposing a test for unclear antecedents, I noticed:

  • some items on the word list had tests, but weren't cross-linked
  • a few items on the word list were missing from tests but easy to add to existing tests

I found a few items that were relatively easy to resolve:

  • Rule against the spelling e-mail wasn't in a substitution test, but was an easy addition to SubstitutionSuggestions.yml
  • Rule for using we recommend instead of it is recommended or GitLab recommends wasn't in a test, but was an easy addition to SubstitutionSuggestions.yml
  • handy, simple, simply, useful were already tested for in Simplicity.yml but the word listed needed to cross-link to the test
  • sub-group was already tested for in SubstitutionSuggestions.yml but the word list needed to cross-link to the test
  • utilize wasn't in a substitution test, but was an easy addition to SubstitutionWarning.yml (I have no problem with moving it down to SubstitutionSuggestions.yml instead)

Screenshots or Screencasts (strongly suggested)

How to setup and validate locally (strongly suggested)

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team
Edited by Amy Qualls

Merge request reports