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

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6ebd81c4c255f8014dbaafaf75f2f9d8e949bb47f133c2dd9d23df720a8c951
+  data.tar.gz: 83fd58828ce3c838ca2f3b4fac7f0092d8b2e8f9efe61b2296e11eaa309eef6e
+SHA512:
+  metadata.gz: 9181f418e83455ff58ae136b7ebbe4b722292a25335194b211fcc65eb1d385229d877eaab8c691af8cd8ef62bfdd022a0474ac690b39c7f0d11008a47dce2851
+  data.tar.gz: 62130a0f765e40fdce8a5f590151c0185da8bf15ef7135ab3a2ba6ba55ca74f3d389096b22444072365fa76eb13fba027f6c0e5a22195f8c2fb8b4b59b893912

data/.rabbit

@@ -0,0 +1 @@
+how-to-change-code.rab

data/README.rd

@@ -0,0 +1,32 @@
+= リーダブルコード演習のコードチェンジ
+
+2022-08-05開催のリーダブルコード演習でのコードチェンジの進め方の説明。
+
+== ライセンス
+
+CC-BY-SA-4.0
+
+原著作者名は以下の通りです。
+
+  * 株式会社クリアコード
+
+== 作者向け
+
+=== 表示
+
+  rake
+
+=== 公開
+
+  rake publish
+
+== 閲覧者向け
+
+=== インストール
+
+  gem install rabbit-slide-Piro-readable-code-workshop-2022-08-05-code-change
+
+=== 表示
+
+  rabbit rabbit-slide-Piro-readable-code-workshop-2022-08-05-code-change.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-code-change
+base_name: how-to-look-back
+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-code-change
+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/how-to-change-code.rab

@@ -0,0 +1,174 @@
+= コードチェンジ
+
+: author
+   結城洋志
+: institution
+   株式会社クリアコード
+: content-source
+   実践リーダブルコード
+: date
+   2022-11-02
+: allotted-time
+   10m
+: theme
+   clear-code
+
+= 目的
+
+  * 他の人の基準で書かれた\n
+    リーダブルコードを探す
+
+= おさらい：今日の体験内容
+
+  * ((*まず自分が読み始める*))
+  * 他の人が書いたコードから\n
+    ((*リーダブルコードの工夫*))を探す\n
+    (('note:（「読みにくいコード」は探さない）'))
+  * リーダブルの基準を\n
+    他人と共有する\n
+    (('note:（チームのリーダブルコードができる）'))
+
+= これからやること
+
+  * 他の人のリポジトリを\n
+    forkする
+  * forkしたリポジトリの\n
+    開発を引き継ぐ
+    * リーダブルなコードを探す
+
+= ポイント
+
+(('tag:center'))
+リーダブルじゃないコードより\n
+リーダブルなコード
+
+((' '))
+
+= リーダブルじゃないコード
+
+  * 見つけやすい
+    * 異質
+    * 読んでいると詰まる
+  * 今日のチャレンジ
+    * 気をとられない
+
+= リーダブルじゃない例
+
+  # _
+   void open_TermList(TermList *list, char *path) {
+     FILE *fp;
+     /* ファイルを開く */
+     if ((fp = fopen(path , "r")) == NULL){
+       fprintf (stderr, "ファイルが開けません\n");
+       fclose(fp);
+       exit(EXIT_FAILURE);
+
+== ノート
+
+ここでは、1行目で閉じ丸括弧と波括弧の間にスペースが空いているのに対して、4行目では閉じ丸括弧と波括弧の間にスペースが空いていない。
+
+= リーダブルなコード
+
+  * 見つけにくい
+    * まわりのコードになじんでいるから
+    * すーっと理解できてひっかからない
+  * 今日のチャレンジ
+    * 意識して見つけよう！
+
+= リーダブルな例
+
+  # _
+   void open_TermList(TermList *list, char *path) {
+     FILE *fp;
+     /* ファイルを開く */
+     if ((fp = fopen(path , "r")) == NULL) {
+       fprintf (stderr, "ファイルが開けません\n");
+       fclose(fp);
+       exit(EXIT_FAILURE);
+
+== ノート
+
+ここでは、先ほどの逆で、1行目と4行目でどちらも、閉じ丸括弧と波括弧の間にスペースが空いている。つまりコーディングスタイルが統一されている。
+
+= やること
+
+  * 同じ言語の他の人の\n
+    リポジトリーをfork
+  * どこまで進んでいるかを把握
+    * リーダブルコードを探す
+  * 開発を継続（改良）
+    * リーダブルコードを探す
+
+
+= リーダブルコードを発見！
+
+  * メモに残す
+    * 自分達の元の作業リポジトリーの\n
+      issueに書く
+  * メモの内容
+    * 実際のコードのURL/コード片
+    * リーダブルと思った理由
+    * 見つけたきっかけ
+
+メモの書き方は先ほどと同じ。
+
+= メモ例
+
+  # _
+  タイトル：統一されたスタイル ← リーダブルな書き方の名前
+
+  ↓本文↓
+  --
+  URL: https://github.com/kou/.../commit/eb02be
+
+  コード:
+  ```
+   void open_TermList(TermList *list, char *path) {
+     FILE *fp;
+     /* ファイルを開く */
+     if ((fp = fopen(path , "r")) == NULL) {
+       fprintf (stderr, "ファイルが開けません\n");
+       fclose(fp);
+       exit(EXIT_FAILURE);
+  ```
+
+  理由:
+  ファイル内で「)」と「{」の間にスペースを空ける、という
+  スタイルに統一しているので読みやすくなっている。
+
+= リーダブルコードとは
+
+  * 読む人基準
+    * 「読む人」が　読みやすいなら\n
+      リーダブル
+
+= どんなコードがリーダブルと言えるか？
+
+  * 読む人（=自分）基準でよい
+    * 自分はどんなコードが\n
+      リーダブルだと思うのか\n
+      言語化してみよう
+    * 凝った書き方を見つけるのは\n
+      目的ではない！
+
+== ノート
+
+「えっこんなことでいいの？」と思うようなことでも、まずは書き出してみよう。
+自分達のチームで実装したときにやっていなかったことは、特にメモに書き出してみよう。
+
+= 見つけ方のポイント
+
+(('tag:center'))
+引き継いだ後\n
+((*スムーズに続きの作業に\n
+取りかかれた*))
+
+→気付きのチャンス
+
+= ここまでの説明
+
+腑に落ちましたか？
+
+= 開始
+
+14:45まで

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: rabbit-slide-Piro-readable-code-workshop-2022-11-02a-code-change
+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-05開催のリーダブルコード演習でのコードチェンジの進め方の説明。
+email:
+- yuki@clear-code.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rabbit"
+- README.rd
+- Rakefile
+- config.yaml
+- how-to-change-code.rab
+- pdf/readable-code-workshop-2022-11-02a-code-change-how-to-look-back.pdf
+homepage: http://slide.rabbit-shocker.org/authors/Piro/readable-code-workshop-2022-11-02a-code-change/
+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: []