Re-enable `jsdoc/require-jsdoc`

Ouverte
#7,628 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Refactorisation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
eslint, typescript
Domaine
tooling

Piste de recherche

Commencez par localiser la configuration de lint spécifique au package dans laquelle jsdoc/require-jsdoc est désactivée, puis choisissez un package pour lequel l’activer. Exécutez les vérifications de lint de ce package et corrigez les violations de la règle de documentation qui en résultent ; le travail est considéré comme terminé lorsque la règle est activée sans laisser de commentaires stub qui enfreignent d’autres règles.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

team-core-platform

The rule jsdoc/require-jsdoc was temporarily disabled because the auto-fixer doesn't work very well (it produced not-very-useful "stub" comment blocks that then violated a bunch of other rules without auto-fixers).

We can enable it one package at a time to break the work up.

Langage dominant
TypeScript
Étoiles
420
Forks
313
Merge moyen
1 j 12 h
PR mergées (30 j)
384

Préparer son environnement

  • Aucun Dockerfile ni fichier Docker Compose
  • Propose un modèle de pull request
  • Aucun guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de MetaMask/core

Toutes les issues de MetaMask/core

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.