Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

formatting.yml: job names 'format (black)' / 'format (isort)' are misleading — both run ruff

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

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

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
76/100
issue の種類
リファクタリング
明瞭さ
おおむね明確
活発さ
活発
技術スタック
github-actions, python
領域
ci-cd

調査の方向性

.github/workflows/formatting.yml から始め、ジョブ名を pythonlint.yml の中立的な命名アプローチと比較します。Ruff コマンドを反映するように checks の名前を変更し、legacy 名に関するコメントを削除して、古い必須 check 名を使用しているリポジトリはルールセットを更新する必要があることを文書化します。

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

説明

Problem

Since the ruff migration (#352 / #353), .github/workflows/formatting.yml no longer runs black or isort, but its jobs are still named after them:

name: "format (${{ matrix.tool }})"
...
matrix:
  include:
    - tool: black
      command: ruff format --check .
    - tool: isort
      command: ruff check --select I .

The comment above explains the names are kept so the required status checks format (black) / format (isort) stay stable for branch protection.

Why it's misleading

  • In the Checks UI and in branch rulesets, a failing "format (black)" suggests black is installed/configured — newcomers look for black config or try black . locally.
  • Repositories created from the template inherit the legacy names even though they never used black/isort, so the "keep required check names stable" reason doesn't apply to them; they just copy the confusion (observed when building a new repo from this template).
  • pythonlint.yml already solved the same concern with a neutral, command-independent name ("Python Code Quality and Lint (...)").

Suggestion

  • Rename the jobs to describe what runs, e.g. Ruff format (ruff format --check .) and Ruff import sorting (ruff check --select I .) — or one job "Ruff formatting" running both.
  • Note in the PR/README that repositories which use the old names as required checks must update their ruleset once.
  • Drop the legacy comment afterwards.
主要言語
Python
スター
8
フォーク
0
平均マージ
2分
マージ済み PR（30日）
9

環境構築

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

はじめの一歩

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

Hochfrequenz/python_template_repository のほかの issue

Hochfrequenz/python_template_repository の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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