Documentation sources are not linted in CI
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 64/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- github-actions, markdown
- 領域
- ci-cd, documentation
調査の方向性
.github/workflows/docs-pull-request.yml から始め、次に docs/Makefile の lint ターゲットと .pre-commit-config.yaml の prettier フックを確認します。既存のドキュメント lint チェックを実行し、docs/ 配下の現在のフォーマットおよび Markdown に関する指摘を解決して、lint の不備があるドキュメントの pull request が CI で失敗することを確認します。
索引モデルが issue の本文から書いたものです。
説明
Documentation pull requests pass CI with formatting and Markdown quality defects which should be caught before review. The docs CI workflow only builds the site (.github/workflows/docs-pull-request.yml); the existing lint Makefile target (docs/Makefile) and the repository pre-commit prettier hook (.pre-commit-config.yaml) are never run by CI. As a result, the current documentation sources already fail formatting on 151 files and carry thousands of Markdown lint findings.
Acceptance criteria
- All current documentation sources under
docs/pass formatting and Markdown lint checks. - A documentation pull request that introduces a formatting or Markdown lint defect fails CI.
- 主要言語
- Python
- スター
- 7.1k
- フォーク
- 603
- 平均マージ
- 3日 8時間
- マージ済み PR（30日）
- 102
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Flagsmith/flagsmith のほかの issue
-
Expose whether an organisation is blocked for API usage対応中かも @PiUnknown が 26 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
Flagsmith/flagsmith#8773 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
Environment colors mismatch in audit log view対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
Flagsmith/flagsmith#8681 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
influx_query_manager doesn't catch ApiException, so Influx error responses 500対応中かも @SAY-5 が 1 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
Flagsmith/flagsmith#8510 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Sales dashboard: download_org_data 500s with "Object of type generator is not JSON serializable"対応中かも @Iflaqbhat が 45 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
メンテナーはふだん 1 日以内に返信
Flagsmith/flagsmith の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
-
area:other help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
WingedGuardian/GENesis-AGI#4734 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
peach-mitao/peach#693 ·
メンテナーはふだん 1 日以内に返信
-
Failed result serialization destroys a previously saved JSON result対応中かも @chessing234 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
huggingface/evaluate#867 ·
-
FTP reads inside a transaction use a nonexistent staging path対応中かも @Harsh23Kashyap が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
fsspec/filesystem_spec#2463 ·
メンテナーはふだん 1 日以内に返信