rabbit-slide-Piro-readable-code-workshop-2022-11-02a-implementation 2022.11.02

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 492b5615d1af6b0fa07b0aba5769332c63a5a7a84d047d54ee0fc97375599764
+  data.tar.gz: 79ff2f059fb41e35e6dc10755dbd8591470d96a5f0daefe30eb5474218ae4dd1
+SHA512:
+  metadata.gz: 95fa2b2ec2b5b40501f2b17101e88c45235166eaff2a1774fb5f25ff413a0336b086d1fa3d036796737424b1585e5eb77b13168b8572df0b6a7f69fc80c3a022
+  data.tar.gz: 4788f8e124a180efc583c0715a348531e6519dd00d4b8b46c6067911653e74b5d668fb13deb41fee059aec7dcbc85cc91099f4f1d9b4283b94e61aa6e615a2d7

data/.rabbit

@@ -0,0 +1 @@
+implementation.rab

data/README.rd

@@ -0,0 +1,32 @@
+= リーダブルコード演習 - 課題の実装の進め方
+
+2022-08-04開催のリーダブルコード演習で実装する課題の概要と進め方の説明。
+
+== ライセンス
+
+CC-BY-SA-4.0
+
+原著作者名は以下の通りです。
+
+  * 株式会社クリアコード
+
+== 作者向け
+
+=== 表示
+
+  rake
+
+=== 公開
+
+  rake publish
+
+== 閲覧者向け
+
+=== インストール
+
+  gem install rabbit-slide-kou-readable-code-workshop-2022-08-04-implementation
+
+=== 表示
+
+  rabbit rabbit-slide-kou-readable-code-workshop-2022-08-04-implementation.gem
+

data/Rakefile

@@ -0,0 +1,17 @@
+require "rabbit/task/slide"
+
+# Edit ./config.yaml to customize meta data
+
+spec = nil
+Rabbit::Task::Slide.new do |task|
+  spec = task.spec
+  # spec.files += Dir.glob("doc/**/*.*")
+  # spec.files -= Dir.glob("private/**/*.*")
+  spec.add_runtime_dependency("rabbit-theme-clear-code")
+end
+
+desc "Tag #{spec.version}"
+task :tag do
+  sh("git", "tag", "-a", spec.version.to_s, "-m", "Publish #{spec.version}")
+  sh("git", "push", "--tags")
+end

data/config.yaml

@@ -0,0 +1,22 @@
+---
+id: readable-code-workshop-2022-11-02a-implementation
+base_name: how-to-proceed
+tags:
+- rabbit
+- readable-code
+presentation_date: 2022-11-02
+version: 2022.11.02
+licenses:
+- CC-BY-SA-4.0
+slideshare_id: readable-code-workshop-2022-11-02a-implementation
+speaker_deck_id: 
+ustream_id: 
+vimeo_id: 
+youtube_id: 
+author:
+  markup_language: :rd
+  name: YUKI Hiroshi
+  email: yuki@clear-code.com
+  rubygems_user: Piro
+  slideshare_user: pirooutsiderreflex
+  speaker_deck_user: piroor

data/implementation.rab

@@ -0,0 +1,140 @@
+= 課題の実装の進め方
+
+: author
+   結城洋志
+: institution
+   株式会社クリアコード
+: content-source
+   実践リーダブルコード
+: date
+   2022-11-02
+: allotted-time
+   10m
+: theme
+   clear-code
+
+= 実装の目的
+
+  * 課題の仕様を理解する
+  * 「読まれることを意識して\n
+    　書かれたコード」を用意する
+    * ((*リーダブルなコード*))を書こう！
+
+(('note:（後半戦への布石）'))
+
+= 目的じゃないこと
+
+  * テクニックをたくさん覚える
+  * 難しいプログラムを実装する
+  * プログラムを速く実装する
+  * 高性能なプログラムを実装する
+  * 奇抜な方法で目立つ
+
+= 課題の傾向
+
+  * 技術的に難しいことは\n
+    意図的に避けている
+  * 段階的に改良していく
+  * 時間内で実装しきれない分量
+    * ((*すべて実装する必要はない！*))
+
+= メモを書く
+
+  * 工夫したことはissueに書く
+    * 1つのissueに1つの工夫でOK
+  * メモに含めること
+    * 実際のコードのURLか\n
+      コード片（差分）
+    * リーダブルな理由
+
+= メモ例
+
+  # _
+  タイトル： 統一されたスタイル ← リーダブルな書き方の名前
+
+  ↓本文↓
+  --
+  URL: https://github.com/kou/.../commit/eb02be
+
+  コード:
+  ```
+  @@ -64,7 +64,7 @@ void add_term_to_TermList(...) {
+   void open_TermList(TermList *list, char *path) {
+     FILE *fp;
+     /* ファイルを開く */
+  -  if ((fp = fopen(path , "r")) == NULL){
+  +  if ((fp = fopen(path , "r")) == NULL) {
+       fprintf (stderr, "ファイルが開けません\n");
+       fclose(fp);
+       exit(EXIT_FAILURE);
+  ```
+
+  理由:
+  ファイル内でスタイルを統一しているので読みやすくなっている。
+
+= リーダブルコードとは
+
+  * 読む人基準
+    * 「読む人」が読みやすいなら\n
+      リーダブル
+  * 読む人の視点を意識してみて
+    * どんな人が読む？
+    * どんな前提知識がある？
+
+= リーダブルにするヒント
+
+  * 要件が増えて、それまでと\n
+    ((*前提が変わった*))とき
+    * 新しい要件に\n
+      惰性ややっつけで対応すると\n
+      リーダブルでなくなりやすい
+
+= リーダブルにするヒント
+
+  * × とりあえず\n
+    　　こう書き足したら動く
+  * ○ 新しい要件に基づいて\n
+    　　コードを見直し、\n
+    　　適切な書き方に改める
+  * 「どうだったらリーダブルか」\n
+    をその都度考え直してみよう
+
+
+
+= 実装に困ったら1
+
+  * 講師に相談
+    * 講師は((*答えを教えない*))
+    * 一緒に考えてくれる
+  * 答えを教えない理由
+    * 参加者が考える機会を奪わないため
+    * 一緒に考えると新しい視点が増える
+
+= 実装に困ったら2
+
+  * 他の人に相談
+    * 答えを教えてもよい
+    * 一緒に考えてもよい
+  * 条件
+    * 答えを教えるときは理由も伝える\n
+      (('note:（教える参加者が考える機会になる！）'))
+    * 聞く人は理由も聞く\n
+      (('note:（考え方を知ると新しい視点でコードを読める！）'))
+
+= 実装開始
+
+  * 仕様
+    * task.md
+  * 練習
+    * 講師がtask.mdを読んで説明
+    * 仕様1を各自で実装
+    * 実装できたらチューターに声掛け\n
+      →仕様2以降実装
+
+= ここまでの説明
+
+腑に落ちましたか？
+
+= 開始
+
+12:15まで

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: rabbit-slide-Piro-readable-code-workshop-2022-11-02a-implementation
+version: !ruby/object:Gem::Version
+  version: 2022.11.02
+platform: ruby
+authors:
+- YUKI Hiroshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rabbit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: rabbit-theme-clear-code
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 2022-08-04開催のリーダブルコード演習で実装する課題の概要と進め方の説明。
+email:
+- yuki@clear-code.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rabbit"
+- README.rd
+- Rakefile
+- config.yaml
+- implementation.rab
+- pdf/readable-code-workshop-2022-11-02a-implementation-how-to-proceed.pdf
+homepage: http://slide.rabbit-shocker.org/authors/Piro/readable-code-workshop-2022-11-02a-implementation/
+licenses:
+- CC-BY-SA-4.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: リーダブルコード演習 - 課題の実装の進め方
+test_files: []