Add codespell as a pre-merge test

Abierto
  • ¿Algo no está bien?
#2,351 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
56/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
github-actions, python
Área
ci-cd, documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement

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
Lenguaje dominante
Python
Estrellas
152
Forks
364
Merge medio
18 h 59 min
PR fusionados (30 d)
35

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de openaps/AndroidAPSdocs

Todos los issues de openaps/AndroidAPSdocs

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.