Add codespell as a pre-merge test

オープン
  • 何か問題がありますか？
#2,351 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
56/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
github-actions, python
領域
ci-cd, documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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
主要言語
Python
スター
152
フォーク
364
平均マージ
18時間 59分
マージ済み PR（30日）
35

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

openaps/AndroidAPSdocs のほかの issue

openaps/AndroidAPSdocs の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。