automated docs review
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- rust
- 領域
- ci-cd, documentation, testing
調査の方向性
ファイル、テスト、エントリポイントは指定されていません。まずリポジトリのドキュメントとCI設定を確認し、その後、Rustの例をどのように識別して実行すべきかを判断してください。ドキュメントの例を確実にチェックできる合意済みのアプローチが確立され、任意のPRに関する推奨事項の範囲が明示的に限定されていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Is your feature request related to a problem? Please describe.
It would be great if there was a CI job that could read the docs, run the examples, and make sure everything was still correct as we merge new PRs. As time passes and features get added/removed, docs (especially those that are example-oriented) can drift away from usefulness.
Describe the solution you'd like
There are a lot of possible solutions to this problem. We could use a simple parser to extract the rust examples and run them, but that could get convoluted quickly. We could also use AI. I don't know which is the best yet, but I'm just writing this quickly so a discussion can start.
The goal (first & foremost) ensure accuracy of code examples in docs.
If we can add AI code reviews and recommendations related to the PR (i.e. to remind the PR's dev to update the docs) that would be an excellent addition.
- 主要言語
- Rust
- スター
- 144
- フォーク
- 58
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
flashbots/contender のほかの issue
-
enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 45/100
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
-
server: export DB from session再び着手できるかも @zeroXbrock が 203 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンenhancement help wanted question
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 62/100
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 52/100
flashbots/contender の issue をすべて見る
似ている issue
-
priority middle
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
KATO-Hiro/AtCoderClans#13029 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
RustCrypto/formats#2544 ·
メンテナーはふだん 1 日以内に返信
-
bug ui
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
userFRM/egui-charts#3363 ·
メンテナーはふだん 1 日以内に返信
-
ada documentation mobile report
難易度 1/5 1時間未満 初心者へのやさしさ 86/100
physicsdolphin/nv-uefi-unlocker#254 · リアクション 2 件 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
kindraywind/rustnarok-client#1382 ·
メンテナーはふだん 1 日以内に返信