Require descriptions for GraphQL types, input objects, and enums, enforced with Rubocop
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Problem
GraphQL field, argument, and enum value descriptions are required, and have a defined styleguide. This is enforced with the Graphql/Descriptions cop.
But GraphQL types, input objects, and enums and are not documented as required, do not have a defined description styleguide, or enforced by a cop.
These are the descriptions that are given to these objects with the description method, example.
Proposal
- Require that types, input objects, and enums have descriptions (through
description). - Define a styleguide for the descriptions if it makes sense to.
- Add a Rubocop (or tweak
Graphql/Descriptions) to enforce rules
Edited by 🤖 GitLab Bot 🤖