Example config files omit the `presence:` block the parser accepts

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

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
69/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
静か
技術スタック
rust
領域
documentation

調査の方向性

crates/podd-core/src/config/mod.rsを読んでPresenceConfigのフィールドを確認し、ARCHITECTURE.mdを読んでAPIの背景を確認してください。次に、config.example.ron、config.pod3.example.ron、config.pod4.example.ronを調べ、オプションの記載方法を確認してください。完了条件は、各例でpresenceの3つのフィールドをコメントブロック内で説明するか、presenceが実行時のみの機能であることを明確に示すことです。

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

説明

documentation good first issue

crates/podd-core/src/config/mod.rs defines Config.presence: Option<PresenceConfig> (fields baselines: [u16;6], threshold: u16, debounce_count: u8), and ARCHITECTURE.md documents a GET/POST /metrics/presence API around it, but none of config.example.ron, config.pod3.example.ron, or config.pod4.example.ron mention presence at all. A user has no documented way to discover or shape this option. Add a commented-out presence: (...) block (with the three fields and their meaning) to the example configs, or explicitly note it's runtime-only.

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 を短くまとめたダイジェスト。