reactjs / reactjs/react.dev

Spellchecking content and other Markdown files in CI

Ouverte
#473 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
JavaScript
Étoiles
11.8k
Forks
7.9k
Merge moyen
1 j 11 h
PR mergées (30 j)
11

Description

Hi there! I've created a command-line tool that checks Markdown and text files for spelling mistakes and some types of grammatical errors. I think it could be useful to run this tool on the documentation and other Markdown files (e.g. README.md) in this repository during CI. If this sounds interesting to you, I'm happy to open a PR.

Guide de contribution

Ouvrir le 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.

Piste de recherche

Examinez la configuration CI du dépôt ainsi que la documentation et les fichiers Markdown, y compris README.md, afin de déterminer comment le spellchecker-cli proposé serait invoqué. Vérifiez le comportement pris en charge par l’outil pour les fichiers Markdown et texte avant de définir le périmètre de la CI. La tâche est terminée lorsque les fichiers sélectionnés sont automatiquement vérifiés par le correcteur orthographique pendant la CI avec une configuration facile à maintenir.

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

Évaluation

Domaine
ci-cd, documentation
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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