Improve documentation on how to instrument logging in a component
メンテナーはふだん 3 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
調査の方向性
まず、リポジトリ内にある既存のロギングに関するドキュメントと、コンポーネントのインストルメンテーションに関するガイダンスを探します。既存の機能がどのように使われているかを確認してから、ワークフローをドキュメント化し、新しいガイダンスでコンポーネントにロギングをインストルメントする方法が明確に説明されていることを確認します。
索引モデルが issue の本文から書いたものです。
説明
Request Type
Undocumented existing feature
What needs to be documented?
As titled; logging docs in general could use more docs, but this is directly valuable to customers.
Where should this be documented?
No response
Why is this needed?
No response
Existing information
No response
Priority/Impact
Medium - important but not urgent
Are you planning to fix this issue?
No, just reporting the issue
First-time contributor support
- I'm new to contributing and would appreciate guidance on the process
- I'd like help understanding the project structure
- I need assistance with setting up the development environment
- I'm comfortable contributing but new to this project specifically
- 主要言語
- MDX
- スター
- 9
- フォーク
- 9
- 平均マージ
- 4日 15時間
- マージ済み PR（30日）
- 37
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
HarperFast/documentation のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
HarperFast/documentation#690 ·
メンテナーはふだん 3 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
HarperFast/documentation#677 ·
メンテナーはふだん 3 日以内に返信
-
難易度 2/5 半日 初心者へのやさしさ 88/100
HarperFast/documentation#675 ·
メンテナーはふだん 3 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
HarperFast/documentation#665 ·
メンテナーはふだん 3 日以内に返信
-
content
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
HarperFast/documentation#478 ·
メンテナーはふだん 3 日以内に返信
HarperFast/documentation の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
area:docs documentation P3
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
Raaif-Yousuf/Wingman#837 ·
メンテナーはふだん 1 日以内に返信
-
documentation good first issue hacktoberfest
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
wassim-azi/agy-powerline#47 ·
メンテナーはふだん 1 日以内に返信
-
area/localization language/es triage/accepted
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
kubernetes/website#58112 ·
メンテナーはふだん 2 日以内に返信
-
agent:working documentation enhancement go:build lane:needs-decision
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
Sanne/incus-spawn#1435 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信