dandk105 / webapp_study

web app の作成を通して、gitの使い方や、ユニットテストについてQAの人が勉強するためのリポジトリです
https://dandk105.github.io/webapp_study/
MIT License
0 stars 0 forks source link

minispecとDesignDocを記載 #27

Open dandk105 opened 11 months ago

dandk105 commented 11 months ago

追加したこと

minispecとDesignDocを記載しました

minispecは主になぜこの機能を作成するかの要求が記載されています

Design Docは主にAPIをどの様に設計しているのかを記載しています。

どちらも、mermaid記法で関係図等を記載しているので、Files changedの詳細メニューからどの様に表示をされるかを確認してください

dandk105 commented 11 months ago

このブランチのdesignDocのプレビュー https://github.com/dandk105/webapp_study/blob/d7c13f532f5e9ba7a84031c0b660da5f442b829a/docs/designdoc/%E3%82%A2%E3%82%AB%E3%82%A6%E3%83%B3%E3%83%88%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6%E3%81%AEdesigndoc.md

このブランチのminispecのプレビュー https://github.com/dandk105/webapp_study/blob/d7c13f532f5e9ba7a84031c0b660da5f442b829a/docs/minispec/%E3%83%A6%E3%83%BC%E3%82%B6%E3%83%BC%E3%81%AF%E8%87%AA%E5%88%86%E3%81%AE%E3%82%A2%E3%82%AB%E3%82%A6%E3%83%B3%E3%83%88%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6%E7%A2%BA%E8%AA%8D%E3%81%99%E3%82%8B%E3%81%93%E3%81%A8%E3%81%8C%E3%81%A7%E3%81%8D%E3%82%8B.md

dandk105 commented 11 months ago

プルリクエストのレビューの仕方について https://docs.github.com/ja/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request

dandk105 commented 11 months ago

@hekoshabo レビューありがとうございます! ❤️ お作法どうのこうのは現在ないです!というかこれから一緒に練っていくものなので、気にしないでください! レビュー指摘を確認して、上位文章であるminispecをもう少し明文化したほうが良いと思ったので対応します。

追加するのは以下の内容を想定しようと思っていますが、それ以外にもどのような内容があれば考える事が楽になるのにとかがあれば教えてください!

dandk105 commented 11 months ago
flowchart TD
    Userdatahandler --> GetUserdata
   Userdatahandler --> CreateUserdata
   Userdatahandler --> DeleteUserdata
   Userdatahandler --> UpdateUserdata

情報の受け渡しは、contextで実施してあげれば良い Getメソッドの時はWithValueで良さそうだが、WithValueはあくまで、関数にキーが設定されているかや 関数に値があるのかを確認する為のものだから Context.Value("username":"Jony")のほうが良さそうってことかな

Context.WithValue(context.Background(),"username","Jony")
Context.WithValue(context.Background(),"birthday",2020/03/18)

情報をリクエストクエリから引き抜く共通の処理が必要そう

req = HttpRequest
req.URL.Query().Get("name")
dandk105 commented 10 months ago

書いたデザインをPDFで追加した