chore: Add more details about log levels
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
調査の方向性
pull request #4314で参照されている変更と、issue #262の既存のドキュメントの文脈を確認します。warnとerrorのどちらを選ぶか、デフォルトのログレベル、検索可能なタグ、ログ行を追加する際の大文字・小文字の使い分けについての指針を文書化します。これらの考慮事項が新しいコントリビューター向けに書き留められていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
@vishnu-narayanan @sojan-official Thanks for this, let us use this as starting point. Can we also include how the choice was made in https://github.com/chatwoot/chatwoot/pull/4314/files?
The expectation is to write down what are the considerations a new person should take while adding a logline. Please see some of the thoughts that need to be captured below.
- When is log-level warn used vs error?
- What is the default log level to be used?
- Should we add any tags to the logs for easy searching?
- Should we capitalize the logs (In the PR some of the logs are using all caps, some are using mixed characters)?
Originally posted by @pranavrajs in https://github.com/chatwoot/docs/issues/262#issuecomment-1106097680
- 主要言語
- MDX
- スター
- 93
- フォーク
- 180
- 平均マージ
- 25分
- マージ済み PR(30日)
- 2
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
chatwoot/docs のほかの issue
-
難易度 1/5 1〜3時間 初心者へのやさしさ 90/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 68/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 42/100
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
btclib-org/btclib#2835 ·
メンテナーはふだん 1 日以内に返信
-
Link Checker Reportオープンautomated issue linkchecker report
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
QuantEcon/lecture-python.myst#1098 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
chipsalliance/caliptra-sw#4335 ·
メンテナーはふだん 1 日以内に返信
-
A-documentation good first issue
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
rust-lang/rust-clippy#17926 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
automated issue report
難易度 1/5 1時間未満 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信