Skip to content
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

Merged
5 commits merged into from May 3, 2021

Conversation

ghost
Copy link

@ghost ghost commented May 2, 2021

PR の目的

リポジトリのルートディレクトリにある単体テストに関するドキュメントを、 tests ディレクトリに移します。

カテゴリ

  • ドキュメント修正

PR の背景

既に Visual Studio 2019 でのビルドと、コンパイルテストの追加が行われましたが、ドキュメントに反映されていませんでした。
また、ルートディレクトリにあるファイルが多すぎるという指摘もありました。

PR のメリット

PR のデメリット (トレードオフとかあれば)

仕様・動作説明

  • 関連情報に挙げた変更を反映させました。
  • ファイル名とタイトルはそのままで、testsディレクトリに移しています。

PR の影響範囲

テスト内容

テスト1

関連 issue, PR

#698 Visual Studio 2019 対応作業(完了済)
#1297 コンパイルテストを導入

#740 ルートディレクトリのファイルを整理する( CI/CD 関係のドキュメントは #1630 で実施済み。)

参考資料

@ghost ghost added the document ドキュメント label May 2, 2021
@@ -31,13 +31,14 @@ cmake を実行することにより、各プラットフォームに固有の

googletest を使用して作成する単体テストも cmake でビルド設定を行います。
Copy link
Contributor

@beru beru May 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

コマンド名は全て小文字の cmake ですが固有名詞としては CMake なので記述を変えたほうが良いと思います。

とはいえ、cmake の見出し以降で全て小文字で書かれているので置き換えるとなると箇所が多いですね。

Copy link
Author

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」のままになっている箇所が残っているので、
今度機会があるときに直しておきます。

Copy link
Author

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 対応の時に行うドキュメント更新に含めるつもりでしたが、対応方法を見直した結果ドキュメントは更新不要と判断したので、この「機会」も当分来ないかもしれません。

@@ -31,13 +31,14 @@ cmake を実行することにより、各プラットフォームに固有の

googletest を使用して作成する単体テストも cmake でビルド設定を行います。

cmake は Visual Studio 2017 用のプロジェクト生成に対応しているため
Visual Studio 2017 用のプロジェクトを生成してビルドすれば
cmake は Visual Studio 用のプロジェクト生成に対応しているため
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ここも同様にコマンド名は全て小文字の cmake ですが固有名詞としては CMake なので記述を変えたほうが良いと思います。

Copy link
Contributor

@beru beru left a 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 にするとブラウザで解説を見やすいかもしれません。

@ghost
Copy link
Author

ghost commented May 3, 2021

レビューありがとうございます。とりあえずこれでマージします。

@ghost ghost merged commit 00bc361 into sakura-editor:master May 3, 2021
@ghost ghost deleted the feature/update_test_document branch May 3, 2021 04:42
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document ドキュメント
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant