NuGetパッケージ公開用リポジトリを作成する

[fkoyama]

概要

#1778 から独立。
NuGetパッケージ公開用のリポジトリを作成し、リポジトリ公開に向けた資材を追加します。

完了条件

• NuGetパッケージ公開用のリポジトリが作成されていること
• 以下がリポジトリに追加されていること
  • README
  • LICENSE
  • CONTRIBUTING
  • Maris.Logging.Testingプロジェクトとそのテストプロジェクト

[fkoyama]

• リポジトリ名候補
  • dotnet-libraries
  • dotnet-components
  • dotnet-modules
    ⇒ dotnet-libraries に決定

[fkoyama]

リポジトリ内のフォルダー構造

①src と test に分けてソースコードとテストコードを配置

• ソースコードとテストコードで別々の設定がしやすい(.editorconfig等)
  • 複数のパッケージのソースコードに関係する設定変更がある場合に作業しやすい
• ソースコードとテストコードの行き来がしづらい
  • パッケージごとの README をソースコード側に配置すると README とテストコードの距離が離れる
• 参考
  • https://github.com/domaindrivendev/Swashbuckle.AspNetCore
  • https://github.com/serilog/serilog
  • https://github.com/dotnet/efcore

②パッケージごとのフォルダーにソースコードとテストコードを配置

• ソースコードとテストコードに対して別々のコンパイラ設定をする場合、管理するファイルが増える可能性がある
  • 複数のパッケージのソースコードに関係する設定変更がある場合は作業しづらい
• ソースコードとテストコードの行き来がしやすい
  • パッケージごとに README、ソースコード、テストコードが1か所にまとまる
• 参考
  • https://github.com/dotnet/aspnetcore
  • https://github.com/JamesNK/Newtonsoft.Json
  • https://github.com/aws/aws-sdk-net

その他

• ソースコードと同じプロジェクト内にテストコードを配置
  • ソースコード側のプロジェクト構成が変更された際にテストコードを移動しやすいことがメリットとして挙げられている
  • プロジェクト自体を統合すると、結局フォルダーを切ってソースコードとテストコードを分離することになるので上記の②とほぼ同じ…？
    https://canvascodebw.medium.com/unit-tests-where-do-you-put-em-c-example-38bd916f8d80

⇒①の方針に決定