-
Notifications
You must be signed in to change notification settings - Fork 167
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
単体テストに関するドキュメントをサブディレクトリに移動する #1654
Conversation
tests/unittest.md
Outdated
@@ -31,13 +31,14 @@ cmake を実行することにより、各プラットフォームに固有の | |||
|
|||
googletest を使用して作成する単体テストも cmake でビルド設定を行います。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
コマンド名は全て小文字の cmake ですが固有名詞としては CMake なので記述を変えたほうが良いと思います。
とはいえ、cmake
の見出し以降で全て小文字で書かれているので置き換えるとなると箇所が多いですね。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ci/build-envvars.md にも「appveyor」のままになっている箇所が残っているので、
今度機会があるときに直しておきます。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ci/build-envvars.md にも「appveyor」のままになっている箇所が残っているので、
今度機会があるときに直しておきます。
githash.bat の GitHub Actions 対応の時に行うドキュメント更新に含めるつもりでしたが、対応方法を見直した結果ドキュメントは更新不要と判断したので、この「機会」も当分来ないかもしれません。
tests/unittest.md
Outdated
@@ -31,13 +31,14 @@ cmake を実行することにより、各プラットフォームに固有の | |||
|
|||
googletest を使用して作成する単体テストも cmake でビルド設定を行います。 | |||
|
|||
cmake は Visual Studio 2017 用のプロジェクト生成に対応しているため | |||
Visual Studio 2017 用のプロジェクトを生成してビルドすれば | |||
cmake は Visual Studio 用のプロジェクト生成に対応しているため |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ここも同様にコマンド名は全て小文字の cmake ですが固有名詞としては CMake なので記述を変えたほうが良いと思います。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
問題無いと思います。
unittest.md
ファイルを tests/unittest.md
に移すだけでなくて tests/README.md
にするとブラウザで解説を見やすいかもしれません。
レビューありがとうございます。とりあえずこれでマージします。 |
PR の目的
リポジトリのルートディレクトリにある単体テストに関するドキュメントを、 tests ディレクトリに移します。
カテゴリ
PR の背景
既に Visual Studio 2019 でのビルドと、コンパイルテストの追加が行われましたが、ドキュメントに反映されていませんでした。
また、ルートディレクトリにあるファイルが多すぎるという指摘もありました。
PR のメリット
PR のデメリット (トレードオフとかあれば)
仕様・動作説明
PR の影響範囲
テスト内容
テスト1
関連 issue, PR
#698 Visual Studio 2019 対応作業(完了済)
#1297 コンパイルテストを導入
#740 ルートディレクトリのファイルを整理する( CI/CD 関係のドキュメントは #1630 で実施済み。)
参考資料