import-js/eslint-plugin-import

Add a description to each rule

Open

#1,968 opened on Dec 26, 2020

View on GitHub
 (1 comment) (1 reaction) (0 assignees)JavaScript (1,540 forks)batch import
docshelp wanted

Repository metrics

Stars
 (4,946 stars)
PR merge metrics
 (Avg merge 138d 22h) (3 merged PRs in 30d)

Description

It would be helpful to include the description property for each rule. Personally, I like to use a simple script which uses meta information such as the URL (which is included for this plugin's rules) and the description (which is not currently included) for each rule.

I would recommend copying the descriptions from the README.

More information about the properties of a rule can be found here: https://eslint.org/docs/developer-guide/working-with-rules#rule-basics

If this suggestion is supported, I would be happy to submit a pull request implementing it.

Contributor guide

Research direction
Copy the descriptions from the README and add them as the `description` property in each rule's meta object. Refer to the ESLint rule basics documentation for the correct structure.
Tech stack
javascript
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85