Add cop to detect invalid beginning description characters (!59) · Merge requests · GitLab.org / ruby / gems / gitlab-styles

Doug Stull requested to merge add-no-caps-at-example-start-cop into master Dec 02, 2020

Description of the proposal

          # This cop will correct docstrings that begin/end with space or words that start with a capital letter.
          #
          # @see https://gitlab.com/gitlab-org/gitlab/-/merge_requests/46336#note_442669518
          #
          # bad
          it 'Does something' do
          end

          # good
          it 'does nothing' do
          end

          # bad
          it ' does something' do
          end

          # good
          it 'does something' do
          end

          # bad
          it 'does something ' do
          end

          # good
          it 'does something' do
          end

          # bad
          it ' does something ' do
          end

          # good
          it 'does something' do
          end

the violations for it on GitLab are now 103

14:56 $ be rubocop --only RSpec/ExampleStartingCharacter ee/spec/
Inspecting 2667 files
..................................................................................................................................................................................................................................................................................................................................C......................................................................................C............................................................................................C...................................C...................C............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................

Offenses:

ee/spec/features/admin/admin_settings_spec.rb:44:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Enables external authentication' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ee/spec/features/admin/admin_settings_spec.rb:92:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Allows limiting projects and namespaces to index', :aggregate_failures, :js do
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ee/spec/features/admin/admin_settings_spec.rb:135:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Allows removing all namespaces and projects', :aggregate_failures, :js do
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ee/spec/features/admin/admin_settings_spec.rb:180:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Enable Slack application' do
      ^^^^^^^^^^^^^^^^^^^^^^^^
ee/spec/features/admin/admin_settings_spec.rb:197:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Render "Templates" section' do
        ^^^^^^^^^^^^^^^^^^^^^^^^^^
ee/spec/features/admin/admin_settings_spec.rb:203:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Render "Custom project templates" section' do
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ee/spec/features/admin/admin_settings_spec.rb:220:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Changes to allow group owners to manage ldap' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ee/spec/features/admin/admin_settings_spec.rb:234:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Does not show option to allow group owners to manage ldap' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ee/spec/features/groups/saml_providers_spec.rb:247:15: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
          it 'Sign in button redirects to auth flow' do
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ee/spec/features/projects/path_locks_spec.rb:21:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Locking folders' do
      ^^^^^^^^^^^^^^^
ee/spec/features/projects/path_locks_spec.rb:31:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Locking files' do
      ^^^^^^^^^^^^^
ee/spec/features/projects/path_locks_spec.rb:45:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Unlocking files' do
      ^^^^^^^^^^^^^^^
ee/spec/features/projects/path_locks_spec.rb:63:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Managing of lock list' do
      ^^^^^^^^^^^^^^^^^^^^^
ee/spec/features/search/elastic/global_search_spec.rb:135:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Ignores nonexistent projects from stale index' do
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ee/spec/features/survey_responses_spec.rb:6:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Shows a friendly message' do
      ^^^^^^^^^^^^^^^^^^^^^^^^

2667 files inspected, 15 offenses detected
✘-1 ~/projects/gdk/gitlab [219241-refine-group-creation-form|…1⚑ 16]
15:34 $ be rubocop --only RSpec/ExampleStartingCharacter spec/
Inspecting 6562 files
....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................C..CCC.....................CC..........................................C..................C...................................C........................................................................CC.........................................................................................................................................................C...............C.CCC...C..........................................................................................................................C................................................................................................................C......................................................................CCC..C..C..................C................................................................................................................................................................................................................................................................................................................................................................................................................................................................C.........C...................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................C......................C.....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................C....................................................................................................................................................................................................................................................................................................................................................................................................................C........C...............................................................................................................................................................................................C..........................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................C.............C..................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................

Offenses:

spec/features/abuse_report_spec.rb:12:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Report abuse' do
      ^^^^^^^^^^^^
spec/features/admin/admin_appearance_spec.rb:9:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Create new appearance' do
      ^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_appearance_spec.rb:30:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Preview sign-in page appearance' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_appearance_spec.rb:40:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Preview new project page appearance' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_appearance_spec.rb:83:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Custom sign-in page' do
      ^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_appearance_spec.rb:89:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Custom new project page' do
      ^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_appearance_spec.rb:114:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Appearance logo' do
      ^^^^^^^^^^^^^^^
spec/features/admin/admin_appearance_spec.rb:127:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Header logos' do
      ^^^^^^^^^^^^
spec/features/admin/admin_broadcast_messages_spec.rb:14:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'See broadcast messages list' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_broadcast_messages_spec.rb:47:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Edit an existing broadcast message' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_broadcast_messages_spec.rb:56:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Remove an existing broadcast message' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_browse_spam_logs_spec.rb:14:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Browse spam logs' do
      ^^^^^^^^^^^^^^^^
spec/features/admin/admin_serverless_domains_spec.rb:15:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Add domain with certificate' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_serverless_domains_spec.rb:35:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Update domain certificate' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_serverless_domains_spec.rb:65:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Displays a modal when attempting to delete a domain' do
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_serverless_domains_spec.rb:76:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Displays a modal with disabled button if unable to delete a domain' do
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:27:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change visibility settings' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:36:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Uncheck all restricted visibility levels' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:50:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Modify import sources' do
          ^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:73:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change Visibility and Access Controls' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:83:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change Keys settings' do
          ^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:101:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change Account and Limit Settings' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:111:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change Maximum import size' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:121:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change New users set to external', :js do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:147:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change Sign-in restrictions' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:157:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Terms of Service' do
          ^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:173:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Modify oauth providers' do
          ^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:193:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Oauth providers do not raise validation errors when saving unrelated changes' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:216:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Configure web terminal' do
          ^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:258:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Enable hiding third party offers' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:268:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change Slack Notifications Service template settings', :js do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:318:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change CI/CD settings' do
          ^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:383:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change Repository storage settings' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:396:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change Spam settings' do
          ^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:424:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change Prometheus settings' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:434:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change Performance bar settings' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:477:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Changes Outbound requests settings' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:495:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Changes Issues rate limits settings' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:513:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change Help page' do
          ^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:534:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change Pages settings' do
          ^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:546:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Change Real-time features settings' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:567:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it "Change Pages Let's Encrypt settings" do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:581:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Shows default help links in nav' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/admin/admin_settings_spec.rb:594:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Shows custom support url in nav when set' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/commits_spec.rb:128:13: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
        it 'Renders header', :js do
            ^^^^^^^^^^^^^^
spec/features/dashboard/shortcuts_spec.rb:16:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Navigate to tabs' do
        ^^^^^^^^^^^^^^^^
spec/features/dashboard/shortcuts_spec.rb:48:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Navigate to tabs' do
        ^^^^^^^^^^^^^^^^
spec/features/groups/board_spec.rb:19:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Adds an issue to the backlog' do
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/issues/create_issue_for_discussions_in_merge_request_spec.rb:108:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Shows a notice to ask someone else to resolve the threads' do
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/issues/create_issue_for_single_discussion_in_merge_request_spec.rb:85:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Shows a notice to ask someone else to resolve the threads' do
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/milestone_spec.rb:104:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it "The delete milestone button does not show for unauthorized users" do
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/profiles/active_sessions_spec.rb:14:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'User sees their active sessions' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/profiles/active_sessions_spec.rb:85:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'User can revoke a session', :js do
      ^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/profiles/emails_spec.rb:45:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'User removes email' do
      ^^^^^^^^^^^^^^^^^^
spec/features/profiles/emails_spec.rb:54:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'User confirms email' do
      ^^^^^^^^^^^^^^^^^^^
spec/features/profiles/emails_spec.rb:66:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'User re-sends confirmation email' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/profiles/gpg_keys_spec.rb:39:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'User sees their key' do
      ^^^^^^^^^^^^^^^^^^^
spec/features/profiles/gpg_keys_spec.rb:48:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'User removes a key via the key index' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/profiles/gpg_keys_spec.rb:57:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'User revokes a key via the key index' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/profiles/keys_spec.rb:67:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'User sees their keys' do
      ^^^^^^^^^^^^^^^^^^^^
spec/features/profiles/user_changes_notified_of_own_activity_spec.rb:12:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'User opts into receiving notifications about their own activity' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/profiles/user_changes_notified_of_own_activity_spec.rb:23:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'User opts out of receiving notifications about their own activity' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/projects/labels/issues_sorted_by_priority_spec.rb:18:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Are sorted properly' do
        ^^^^^^^^^^^^^^^^^^^
spec/features/projects/labels/issues_sorted_by_priority_spec.rb:48:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Are sorted properly' do
        ^^^^^^^^^^^^^^^^^^^
spec/features/projects/show/user_sees_setup_shortcut_buttons_spec.rb:25:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Project buttons are not visible' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/snippets/private_snippets_spec.rb:14:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Private Snippet renders for creator' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/snippets/public_snippets_spec.rb:9:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Unauthenticated user should see public snippets' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/snippets/public_snippets_spec.rb:21:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Unauthenticated user should see raw public snippets' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/snippets/search_snippets_spec.rb:6:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'User searches for snippets by title' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/snippets/user_creates_snippet_spec.rb:28:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Authenticated user creates a snippet' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/snippets/user_snippets_spec.rb:16:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'View all of my snippets' do
      ^^^^^^^^^^^^^^^^^^^^^^^
spec/features/snippets/user_snippets_spec.rb:22:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'View my public snippets' do
      ^^^^^^^^^^^^^^^^^^^^^^^
spec/features/snippets/user_snippets_spec.rb:32:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'View my internal snippets' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/snippets/user_snippets_spec.rb:42:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'View my private snippets' do
      ^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/users/active_sessions_spec.rb:6:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Successful login adds a new active user login' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/users/active_sessions_spec.rb:29:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Successful login cleans up obsolete entries' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/users/active_sessions_spec.rb:43:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Sessionless login does not clean up obsolete entries' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/features/users/active_sessions_spec.rb:59:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Logout deletes the active user login' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/helpers/clusters_helper_spec.rb:134:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Diplays generic cluster and reports error' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/helpers/emails_helper_spec.rb:299:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Produces the right List-Id' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/models/ci/build_trace_chunk_spec.rb:94:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Chunk size can not be changed without special care' do
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/models/ci/pipeline_spec.rb:2851:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it ' does not add pipeline error message' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/requests/api/graphql_spec.rb:108:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Authenticates users with a PAT' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/services/application_settings/update_service_spec.rb:52:11: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
      it 'Only queries once when the terms are changed' do
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/services/auto_merge/merge_when_pipeline_succeeds_service_spec.rb:194:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Posts a system note' do
        ^^^^^^^^^^^^^^^^^^^
spec/services/git/tag_hooks_service_spec.rb:22:9: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
    it 'Executes system hooks' do
        ^^^^^^^^^^^^^^^^^^^^^
spec/support/shared_examples/features/reportable_note_shared_examples.rb:32:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Report button links to a report page' do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/support/shared_examples/features/wiki/user_uses_wiki_shortcuts_shared_examples.rb:15:7: C: RSpec/ExampleStartingCharacter: Only start with lowercase alpha when describing your tests.
  it 'Visit edit wiki page using "e" keyboard shortcut', :js do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

6562 files inspected, 88 offenses detected

Check-list

Mention this proposal in the relevant Slack channels (e.g. #development, #backend, #frontend)
If there is a choice to make between two potential styles, set up an emoji vote in the MR:
- CHOICE_A: 🅰
- CHOICE_B: 🅱
- Vote yourself for both choices so that people know these are the choices
The MR doesn't have significant objections, and is getting a majority of 👍 vs 👎 (remember that we don't need to reach a consensus)
(If applicable) One style is getting a majority of vote (compared to the other choice)
(If applicable) Update the MR with the chosen style
Follow the review process as usual

Contributes to https://gitlab.com/gitlab-org/gitlab/-/issues/280840

/cc @gitlab-org/maintainers/rails-backend

Edited Dec 03, 2020 by Doug Stull

Add cop to detect invalid beginning description characters

Description of the proposal

Check-list

Merge request reports