import-js/eslint-plugin-import

Add a description to each rule

Open

#1 968 ouverte le 26 déc. 2020

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)JavaScript (1 540 forks)batch import
docshelp wanted

Métriques du dépôt

Stars
 (4 946 stars)
Métriques de merge PR
 (Merge moyen 138j 22h) (3 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Copiez les descriptions du README et ajoutez les comme propriété `description` dans l'objet meta de chaque règle. Référez vous à la documentation de base des règles ESLint pour la structure correcte.
Stack technique
javascript
Domaine
developer experiencetooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JavaScriptESLint
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85