import-js/eslint-plugin-import

Add a description to each rule

Open

#1.968 geöffnet am 26. Dez. 2020

Auf GitHub ansehen
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)JavaScript (1.540 Forks)batch import
docshelp wanted

Repository-Metriken

Stars
 (4.946 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 138T 22h) (3 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Kopieren Sie die Beschreibungen aus der README und fügen Sie sie als `description` Eigenschaft im meta Objekt jeder Regel hinzu. Beachten Sie die ESLint Regelgrundlagen Dokumentation für die korrekte Struktur.
Tech Stack
javascript
Domain
developer experiencetooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaScriptESLint
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85