How do we want to document clang-tidy and clang-format config options?
オープン
まだ誰も着手していません。
- 主要言語
- C++
- スター
- 74
- フォーク
- 9
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Would it be useful to add documentation in the config files about different clang-tidy options for example? Or would we rather document in a readme?
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、リポジトリ内の clang-tidy と clang-format の設定ファイル、および README ドキュメントをすべて見つけます。設定オプションを説明できる場所を比較し、どのオプションを対象にする必要があるか、またドキュメントを設定ファイルと README のどちらに置くべきかを明確にします。プロジェクトでドキュメントの配置場所について合意され、関連するオプションがそこに記載されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- cpp
- 領域
- documentation, tooling
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 20/100