Add codespell as a pre-merge test
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 56/100
- Type d'issue
- Fonctionnalité
- Clarté
- Clairement spécifiée
- Activité
- À l'abandon
- Stack technique
- github-actions, python
- Domaine
- ci-cd, documentation
Piste de recherche
Start by reviewing the sample workflow in the issue and the repository’s existing GitHub Actions workflows. Check how documentation files are organized under docs/EN, then determine how the workflow should run codespell on pull requests to master and report typos while allowing merges. Done means the pre-merge check runs and flags spelling issues as described.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
I went through a lot of typos in the docs and I'd like to suggest that we have a pre-check github action before the maintainer merges. The check will allow the contributor to fix their typos, thereby getting a cleaner commit in the first go.
My PR shows how things can get over time :)
Here is a sample I whipped up.
name: Codespell Pre-Check
on:
pull_request:
branches: [ master ]
jobs:
spellcheck:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Install codespell
run: pip install codespell
- name: Run codespell
continue-on-error: true # <== Allows merge but flags typos
run: codespell --ignore-words-list="Equil,dependant,Chek,LimiTTer,BU" docs/EN
- Langage dominant
- Python
- Étoiles
- 152
- Forks
- 364
- Merge moyen
- 18 h 59 min
- PR mergées (30 j)
- 35
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de openaps/AndroidAPSdocs
-
Difficulté 2/5 1-3 heures Accessibilité débutants 63/100
openaps/AndroidAPSdocs#2667 ·
Les mainteneurs répondent en général sous 1 jour
-
bug help wanted
Difficulté 3/5 1-2 jours Accessibilité débutants 47/100
openaps/AndroidAPSdocs#2449 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
enhancement
Difficulté 4/5 3-5 jours Accessibilité débutants 44/100
openaps/AndroidAPSdocs#1261 · 6 commentaires ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de openaps/AndroidAPSdocs
Issues similaires
-
docs size:S
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
Les mainteneurs répondent en général sous 1 jour
-
documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 74/100
strawberry-graphql/strawberry#4794 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
dataforgoodfr/cetolog#21 ·
-
security_citations_test fails against ecc 2026.11.6: SECURITY.md quotes ecc v2026.11.2's linesOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
btclib-org/btclib#2932 ·
Les mainteneurs répondent en général sous 1 jour