Introduce spell checking

Aperta
  • Qualcosa non va?
#731 4 commenti 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
38/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
ci-cd, tooling

Direzione di ricerca

Start by reading the repository's existing CI configuration and checking how its linting workflow is set up; the issue specifically proposes a version-controlled cspell.json dictionary and a cspell CLI check in CI. Done means the project has a spell-checking configuration and a CI workflow that runs it, with project-specific words handled by the dictionary.

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

Descrizione

I noticed this one while I was working on #632:
I've found a few tiny typos here and there throughout the codebase. To avoid this, I usually use tools like cspell which has amazing IDE integration.

From a basic workflow, all that's required is to add a custom cspell.json-file. In this file, all expressions that are not recognized as words (e.g. pylops, signalprocessing) can be added in a custom dictionary. This dictionary is subject to version control and whenever one developer adds a new word, this word is also known by the cspell of other developers working on pylops after a pull/merge.

All expressions that are not considered as words and cannot be found in this dictionary will be underlined and flagged as typos by cspell until fixed or added to the dictionary. There is even a cli-tool for this, which would be a great addition to a CI workflow aside from linting.

The nice thing about this is that it requires very little commitment. Whenever one encounters an unknown expression, one can either add it to the dictionary or fix the typo. Consequently, the codebase would be cleared from typos step by step with every commit. After some transition phase, spell checking could then be made mandatory and run in the CI.

Lingua principale
Python
Stelle
539
Fork
126
Merge medio
2g 17h
PR unite (30g)
21

Preparare l'ambiente

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.

Altre issue di PyLops/pylops

Tutte le issue di PyLops/pylops

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.