import-js/eslint-plugin-import

Add a description to each rule

Open

#1968 aperta il 26 dic 2020

Vedi su GitHub
 (1 commento) (1 reazione) (0 assegnatari)JavaScript (1540 fork)batch import
docshelp wanted

Metriche repository

Star
 (4946 star)
Metriche merge PR
 (Merge medio 138g 22h) (3 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Copia le descrizioni dal README e aggiungile come proprietà `description` nell'oggetto meta di ogni regola. Fai riferimento alla documentazione di base delle regole di ESLint per la struttura corretta.
Tech stack
javascript
Dominio
developer experiencetooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JavaScriptESLint
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85