From 1fe6f4bf2046fd44f51c5d36e13051e1d0e7333d Mon Sep 17 00:00:00 2001 From: YamazakiYusuke Date: Fri, 10 Jan 2025 07:43:08 +0900 Subject: [PATCH 1/5] =?UTF-8?q?=E8=AA=B2=E9=A1=8C1=EF=BC=88=E8=B3=AA?= =?UTF-8?q?=E5=95=8F=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../\350\252\262\351\241\214.md" | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 "95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" diff --git "a/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" "b/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" new file mode 100644 index 0000000..144b15a --- /dev/null +++ "b/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" @@ -0,0 +1,34 @@ +# 課題1（質問） +## PR（プルリクエスト）は小さく提出することが良しとされる現場が多い傾向にあります。 +- [巨大なプルリクの弊害と対策](https://agilejourney.uzabase.com/entry/2023/07/31/103000) + - フィードバックを受け取るのが遅くなる + +- PRが小さいことのメリットはなにか + +1. 1時間以上かかるコードレビューは低品質になる +> Making Software ―エビデンスが変えるソフトウェア開発という書籍の18章「Modern Code Review」では1時間を超えるコードレビューは品質が低下することを示す研究が紹介されています。[4] +> +> 加えて、シスコシステムズで行われた調査によると、1時間に500LOC(Line of Code)を超える速度でレビューを行うと、不具合の検出効率が低下することが分かったと報告しています。 + +[Pull requestの理想的なサイズとその理由](https://zenn.dev/isana/articles/ideal-size-of-pull-request-and-why#1%E6%99%82%E9%96%93%E4%BB%A5%E4%B8%8A%E3%81%8B%E3%81%8B%E3%82%8B%E3%82%B3%E3%83%BC%E3%83%89%E3%83%AC%E3%83%93%E3%83%A5%E3%83%BC%E3%81%AF%E4%BD%8E%E5%93%81%E8%B3%AA)より + +- 小さいPRを作るときに気をつけることはなにか + 1. 1つのPRに含まれる関心事をできるだけ減らすことで、レビューワーにも理解しやすいPRにする。 + 2. タスクに含まれている作業を洗い出しておく + タスクに含まれる作業を洗い出し、サブタスクを作成する。サブタスクごとにbranchを分けて実装し、PRにする。 + 3. リファクタ/変更/追加でPRを分ける + 機能実装で、コードが汚いからリファクタリング仕様となったら、リファクタリングを行うbranchと、リファクタリングBranchを基にした機能実装を行うブランチを分ける。 + 4. git reset を活用する（PR作成前のみ） + 探り探りのタスクでは、計画的に分散してPRを出すことは難しいので、実装後にコミットを巻き戻して、実装を確認して、実装を分離しPRにする。(整理する際はbranch切ってからやるのが良いかも) + + +## 設計・実装に関する情報の置き場はたくさんあります。どのような情報をどこに置くべきでしょうか？ + + +# 課題2（実装） +## GitHubのPRやIssueにテンプレートを設定する機能があります。実際に作ってみましょう！ + + + +# 課題3 +## チーム開発を円滑にするために上記以外に効果のありそうな取り組みを探して、ペアに共有してみて下さい \ No newline at end of file From 57378a5eb1cb81f3f5c13f2fbe44fc62b2c8d393 Mon Sep 17 00:00:00 2001 From: YamazakiYusuke Date: Fri, 10 Jan 2025 08:15:47 +0900 Subject: [PATCH 2/5] =?UTF-8?q?=E8=AA=B2=E9=A1=8C1=EF=BC=88=E8=B3=AA?= =?UTF-8?q?=E5=95=8F=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../\350\252\262\351\241\214.md" | 28 ++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git "a/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" "b/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" index 144b15a..86ced62 100644 --- "a/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" +++ "b/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" @@ -10,7 +10,7 @@ > > 加えて、シスコシステムズで行われた調査によると、1時間に500LOC(Line of Code)を超える速度でレビューを行うと、不具合の検出効率が低下することが分かったと報告しています。 -[Pull requestの理想的なサイズとその理由](https://zenn.dev/isana/articles/ideal-size-of-pull-request-and-why#1%E6%99%82%E9%96%93%E4%BB%A5%E4%B8%8A%E3%81%8B%E3%81%8B%E3%82%8B%E3%82%B3%E3%83%BC%E3%83%89%E3%83%AC%E3%83%93%E3%83%A5%E3%83%BC%E3%81%AF%E4%BD%8E%E5%93%81%E8%B3%AA)より +[Pull requestの理想的なサイズとその理由](https://shorturl.at/84Ii1)より - 小さいPRを作るときに気をつけることはなにか 1. 1つのPRに含まれる関心事をできるだけ減らすことで、レビューワーにも理解しやすいPRにする。 @@ -24,6 +24,32 @@ ## 設計・実装に関する情報の置き場はたくさんあります。どのような情報をどこに置くべきでしょうか？ +### Notionなどのドキュメント +- プロジェクト全体の概要 +- タスクの管理情報 + +### README.md +- プロジェクトの概要 +- 依存関係とインストール手順 + +### プルリクエストの説明欄 +- 変更内容の概要 +- 確認手順 +- 関連するIssueやタスク + +### コミットメッセージ +- 具体的な変更内容 +- (option)理由や背景 + +### コードコメント +- 複雑なロジックの説明 +- 関数やクラスの目的 +- 重要な注意点 + +### 型定義 +- データ構造の説明 + +[コードのコメントとしてできるだけ実装に近い箇所におく。](https://shorturl.at/pZNC4) # 課題2（実装） ## GitHubのPRやIssueにテンプレートを設定する機能があります。実際に作ってみましょう！ From 95f81f9daf01841abdfc0a464919038f09f7778d Mon Sep 17 00:00:00 2001 From: YamazakiYusuke Date: Fri, 10 Jan 2025 08:35:54 +0900 Subject: [PATCH 3/5] =?UTF-8?q?=E8=AA=B2=E9=A1=8C2=EF=BC=88=E5=AE=9F?= =?UTF-8?q?=E8=A3=85=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../\350\252\262\351\241\214.md" | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git "a/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" "b/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" index 86ced62..557b4f1 100644 --- "a/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" +++ "b/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" @@ -53,8 +53,8 @@ # 課題2（実装） ## GitHubのPRやIssueにテンプレートを設定する機能があります。実際に作ってみましょう！ - +https://github.com/YamazakiYusuke/praha-challenge-ddd/blob/master/.github/PULL_REQUEST_TEMPLATE.md # 課題3 -## チーム開発を円滑にするために上記以外に効果のありそうな取り組みを探して、ペアに共有してみて下さい \ No newline at end of file +## チーム開発を円滑にするために上記以外に効果のありそうな取り組みを探して、ペアに共有してみて下さい From 98423968fcc9ffafef736ba32258528370209233 Mon Sep 17 00:00:00 2001 From: YamazakiYusuke Date: Fri, 10 Jan 2025 08:39:07 +0900 Subject: [PATCH 4/5] =?UTF-8?q?=E8=AA=B2=E9=A1=8C3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../\350\252\262\351\241\214.md" | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git "a/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" "b/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" index 557b4f1..8970fd0 100644 --- "a/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" +++ "b/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" @@ -57,4 +57,6 @@ https://github.com/YamazakiYusuke/praha-challenge-ddd/blob/master/.github/PULL_R # 課題3 -## チーム開発を円滑にするために上記以外に効果のありそうな取り組みを探して、ペアに共有してみて下さい +## チーム開発を円滑にするために上記以外に効果のありそうな取り組みを考えてみて、ペアに共有してみて下さい +- 定期的に技術的な課題や全体に影響する実装を共有する場として、Topic定例を行う。 +- 勉強会などで知識を共有する場を設ける \ No newline at end of file From 70a2b36b01a035896797ebad8b497ca0ff7b92b2 Mon Sep 17 00:00:00 2001 From: YamazakiYusuke Date: Mon, 27 Jan 2025 08:53:51 +0900 Subject: [PATCH 5/5] fix file path --- .../\350\252\262\351\241\214.md" | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename "95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" => "95IG7y3HHX7yl4/07_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" (100%) diff --git "a/95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" "b/95IG7y3HHX7yl4/07_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" similarity index 100% rename from "95IG7y3HHX7yl4/07_linter\343\202\222\344\275\277\343\201\212\343\201\206/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md" rename to "95IG7y3HHX7yl4/07_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272/03_\343\203\201\343\203\274\343\203\240\351\226\213\347\231\272\343\202\222\345\206\206\346\273\221\343\201\253\343\201\231\343\202\213\343\202\263\343\203\204\343\202\222\350\246\232\343\201\210\343\202\210\343\201\206/\350\252\262\351\241\214.md"