Crate names pod-update vs pod-updater are near-identical and easy to confuse

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
48/100
issue の種類
リファクタリング
明瞭さ
おおむね明確
活発さ
静か
技術スタック
rust
領域
developer-experience

調査の方向性

Start by reading the crate module docs in crates/pod-update/src/lib.rs, crates/podup/src/main.rs, and crates/pod-updater/src/lib.rs to understand each crate’s role. Then trace crate names through workspace manifests and imports to assess the rename’s scope. Done when one crate has a distinct name and the workspace builds with references updated.

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

説明

enhancement

The three updater crates are not redundant: pod-update is the shared core lib (manifest/sign/digest/package), podup is the host-side release/sign/verify CLI, and pod-updater is the device-side pull agent (module docs at crates/pod-update/src/lib.rs:1-12, crates/podup/src/main.rs:1-11, crates/pod-updater/src/lib.rs:1-13). But pod-update vs pod-updater differ by one character and are trivially mixed up in imports and conversation; consider renaming one (e.g. pod-update -> pod-update-core, or pod-updater -> pod-update-agent) to remove the footgun.

Filed from a repo-wide code audit (working tree at bcad746).

主要言語
Rust
スター
0
フォーク
0
30日以内にマージされた PR はありません

環境構築

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

はじめの一歩

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

GoogleBot42/podd のほかの issue

GoogleBot42/podd の issue をすべて見る

似ている issue

Rust の issue をもっと見る

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

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