Skip to content

Enforce GraphQL descriptions styleguide for A/The

Luke Duncalfe requested to merge ld-enforce-graphql-description-starts into master

What does this MR do?

Our GraphQL description styleguide states:

Do not start descriptions with The.

Previously, @eread has also expressed that this should extend to 'A'.

This change adds a new offence to our Graphql/Descriptions cop for description strings that start with "The" or "A".

Existing offenses have been added to .rubocop_manual_todo and will be fixed in #337596 (closed).

How to setup and validate locally (strongly suggested)

Remove one of the lines added to .rubocop_manual_todo in this MR and then run rubocop on it. It will display the offense.

rubocop app/graphql ee/app/graphql

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Edited by Luke Duncalfe

Merge request reports