Consider adding a Clang-Tidy configuration to enforce some coding conventions
関連するプルリクエストがすでにマージされています。
- #345 @walbourn による — マージ済み
評価
調査の方向性
まず、オープンなプルリクエスト #345 と、リポジトリの現在の EditorConfig およびコーディングスタイルの設定を確認します。提案されている Clang-Tidy の命名チェックと、適用可能な Clang-Format ルールをプロジェクトの既存の規約と比較します。合意された設定が現在のツールと競合せずに追加されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Take your project DirectXTK as an example, in which you have set these conventions:
PascalCase for class names, methods, functions, and enums.
camelCase for class member variables, struct members
UPPERCASE for preprocessor defines (and nameless enums)
To enforce these naming conventions, you can add readability-* to the checks as shown below:
Checks: >
-*,
readability-*
Then add some of these check options:
CheckOptions:
readability-identifier-naming.ClassCase: 'CamelCase'
readability-identifier-naming.ClassMethodCase: 'CamelCase'
readability-identifier-naming.FunctionCase: 'CamelCase'
readability-identifier-naming.EnumCase: 'CamelCase'
readability-identifier-naming.ClassMemberCase: 'camelBack'
readability-identifier-naming.MemberCase: 'camelBack'
readability-identifier-naming.MacroDefinitionCase: 'UPPER_CASE'
readability-identifier-naming.EnumConstantCase: 'UPPER_CASE'
Microsoft Visual Studio supports Clang-Tidy and Clang-Format out of the box.
P.S.: while EditorConfig is fine, I think you can enforce more specific code-style conventions, such as east const and west const with Clang-Format.
Using Clang-Tidy (and perhaps also Clang-Format) could help maintain greater code consistency.
Reference:
- 主要言語
- C++
- スター
- 1.8k
- フォーク
- 262
- 平均マージ
- 3日 21時間
- マージ済み PR（30日）
- 7
環境構築
このプロジェクトの環境構築ファイルはまだ確認していません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoft/DirectXMath のほかの issue
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
microsoft/DirectXMath#349 ·
-
enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
microsoft/DirectXMath#328 ·
-
simplemath
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
microsoft/DirectXMath#327 · コメント 1 件 ·
-
Project feedbackオープン
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
microsoft/DirectXMath#326 · コメント 2 件 ·
-
arm64 maintenance
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
microsoft/DirectXMath#309 ·
microsoft/DirectXMath の issue をすべて見る
似ている issue
-
upstream update
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
conan-io/conan-center-index#31098 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 2 日以内に返信
-
bug chart-audit
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
godotengine/godot#124120 ·
メンテナーはふだん 1 日以内に返信
-
Component: R Type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
apache/arrow#51695 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信