import-js / import-js/eslint-plugin-import
Add a description to each rule
- Dominant language
- JavaScript
- Stars
- 5.9k
- Forks
- 1.5k
- PR merge metrics
- No 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
Start by reviewing the README descriptions and the rule metadata referenced in the issue, then compare them across the plugin's rules. Confirm how each rule currently exposes its URL and other properties. Done means every rule includes a matching description copied from the README and the metadata remains consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, javascript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100