Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(no-desc): inadequate-description rule #16

Open
4 tasks
gregswindle opened this issue Jun 16, 2017 · 0 comments
Open
4 tasks

feat(no-desc): inadequate-description rule #16

gregswindle opened this issue Jun 16, 2017 · 0 comments

Comments

@gregswindle
Copy link
Owner

gregswindle commented Jun 16, 2017

User story

As an API producer and consumer,
I must provide a succinct and expressive API object, method, and property descriptions
In order to express the API's value and usage to (potential) consumers.

Acceptance criteria

  • 1. required {boolean} Declares whether a description must be written.
  • 2. minChars {number} A minimum character count can be configured.
  • 3. maxChars {number} A maximum character count can be imposed.
  • 4. markdown {boolean} Require markdown formatting in the description (or not).

⚡ Rule developers must use the eslint:rule subgenerator!

When you create a new rule, be sure to use the eslint:rule subgenerator, since it will

  1. Create a stubbed rule,
  2. The rule's stubbed BDD specs,
  3. As well as the rule's documentation.

See eslint-plugin development environment for details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

1 participant