reactjs / reactjs/react.dev

Spellchecking content and other Markdown files in CI

Aperta
#473 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
JavaScript
Stelle
11.8k
Fork
7.9k
Merge medio
1g 11h
PR unite (30g)
11

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Esamina la configurazione CI del repository e la documentazione e i file Markdown, incluso README.md, per determinare come dovrebbe essere invocato lo spellchecker-cli proposto. Verifica il comportamento supportato dallo strumento per Markdown e i file di testo prima di definire l'ambito della CI. L'attività è completata quando i file selezionati vengono sottoposti automaticamente al controllo ortografico durante la CI tramite una configurazione manutenibile.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
ci-cd, documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.