Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

chore: Add more details about log levels

オープン
#338 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
領域
documentation

調査の方向性

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.

  1. When is log-level warn used vs error?
  2. What is the default log level to be used?
  3. Should we add any tags to the logs for easy searching?
  4. 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 を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

chatwoot/docs のほかの issue

chatwoot/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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