Lightning-AI/pytorch-lightning

Update the docformatter pre-commit action

オープン

#16,257 opened on 2023/01/04

GitHub で見るコントリビューターガイド
 (7 件のコメント) (0 件のリアクション) (1 人の担当者)Python (3,233 件のフォーク)batch import
cigood first issue

Repository metrics

Stars
 (26,687 個のスター)
PR merge metrics
 (平均マージ 9d 15h) (30d で 3 merged PRs)

説明

Outline & Motivation

docformatter v1.5.1 was released but we are still using v1.4 after we saw issues.

github.com/PyCQA/docformatter: v1.4 → v1.5.1

Pitch

Update this line: https://github.com/Lightning-AI/lightning/blob/3326e65bb2f7de2040bdf300dca062c627cdddb1/.pre-commit-config.yaml#L59

To v1.5.1

Then resolve the failures caused by the update.

Additional context

Already attempted in https://github.com/Lightning-AI/lightning/pull/16224 and #15344

cc @borda @carmocca @akihironitta

コントリビューターガイド

調査方針
.pre commit config.yaml の 59 行目にある docformatter のバージョンを v1.4 から v1.5.1 に更新してください。その後、pre commit フックを実行して、失敗を特定し解決してください。潜在的な問題についての文脈を得るために、PR #16224 と #15344 での以前の試みを確認してください。担当者 @borda がガイダンスを提供する可能性があります。
技術スタック
python
領域
devopstooling
Issue 種別
保守作業
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Gitpre commitPython
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60