OSS Gate Workshop: Kosen: 2017-09-02: Taillook: SDWebImage Work log

[Taillook]

This is a work log of a "OSS Gate workshop".
"OSS Gate workshop" is an activity to increase OSS developers.
Here's been discussed in Japanese. Thanks.

作業ログ作成時の説明

以下のテンプレートを埋めてタイトルに設定します。埋め方例はスクロールすると見えてきます。

OSS Gate Workshop: ${LOCATION}: ${YEAR}-${MONTH}-${DAY}: ${アカウント名}: ${OSS名}: Work log

タイトル例↓：

OSS Gate Workshop: Tokyo: 2017-01-16: kou: Rabbit: Work log

OSS Gateワークショップ関連情報

• スライド：ワークショップの進行に使っているスライドがあります。
• チャット：OSS開発に関することならなんでも相談できます。ワークショップが終わった後もオンラインで相談しながら継続的にOSSの開発に参加しましょう！
• シナリオ：ワークショップの目的・内容・進め方の詳細が書いています。
• 過去のビギナーの作業ログ：他の人の作業ログから学べることがいろいろあるはずです。

[tjnet]

田中純 @tjnet といいます。よろしくお願いします! SDWebImage 楽しみですね!

[Taillook]

丸尾一真 @Taillook といいます．よろしくお願いします！

[Taillook]

SDWebImageと検索した
GitHubのページが見つかった
https://github.com/rs/SDWebImage

[Taillook]

READMEのLicensesの項目を見るとMITLicenseであることがわかった

[Taillook]

リポジトリをクローンした

[tjnet]

なんか、こうあれですねえ。"開発" "Demoを動かす"への参加の敷居がちょっと高いライブラリかなと思います

• How to contributionみたいなDocsがあるとか。(あるのかな?)

• ReactiveSwiftみたいにPlaygroundで簡単に色々できるとか
  https://github.com/ReactiveCocoa/ReactiveSwift#playground

• Examplesのbuildの仕方がわかりにくいなーと思いました

[Taillook]

CONTRIBUTING.mdが探しづらかった

[tjnet]

なるほど、ここにあるんですね。READMEにリンク書いてあげても良い気もしますね。

SDWebImage/CONTRIBUTING.md at master · rs/SDWebImage

[tjnet]

手元でビルドしきるとこまで持っていって、わかりにくかった記述、足りない記述があればそれをフィードバックしてあげるとか

[tdtds]

いまなにをやっているかを、もっと細かくメモにとりましょう。なにかエラーが出たらそのログを貼りましょう。

[Taillook]

Examplesを実行する

[Taillook]

ExamplesをビルドするとApple LLVM 8.1 Error Groupというエラーが出た

No such file or directory: '/Users/taillook/project/SDWebImage/Vendors/libwebp/src/dec/tree_dec.c'
No input files
No such file or directory: '/Users/taillook/project/SDWebImage/Vendors/libwebp/src/dsp/dec_clip_tables.c'
No such file or directory: '/Users/taillook/project/SDWebImage/Vendors/libwebp/src/dsp/rescaler_mips_dsp_r2.c'

[ashie]

CONTRIBUTING.mdが探しづらかった

これを探そうと思った理由があると良いと思いました
（あとから振り返ると、「まず動かす」というアクションに至る情報が足りていなくて、アクションに飛躍があるように見えました）

[Taillook]

Apple LLVM 8.1 Error Groupについて他の人がissueで書いていないか調べる

[selmertsx]

https://github.com/rs/SDWebImage/blob/master/Docs/ManualInstallation.md

[Taillook]

https://github.com/rs/SDWebImage#installation-by-cloning-the-repository
これを実行する

(同じエラーの人が居た)
SDWebImage/SDWebImage#1067

[Taillook]

https://github.com/rs/SDWebImage#installation-by-cloning-the-repository
のOther Linker Flagsがリンク切れになっていた

[tjnet]

なるほど! もうこれPull Request出しちゃっていいと思いますよ 😄 mergeされるはず...
うーん、これリンクどこにあるんだ、、正解がわからないのでPRじゃなくてissue出すことにしましょうか

[tjnet]

これ、僕がAlamofireObjectMapperのドキュメントを修正したときの例なのですが、issueは、こんな感じで書いてあげると良いかと。

Extra Argument in call error · Issue #166 · tristanhimmelman/AlamofireObjectMapper

あと要素としてあった方がいいのは

• やったこと
• やっていないこと
• 期待している結果

[tjnet]

https://github.com/rs/SDWebImage/blob/master/.github/CONTRIBUTING.md#reporting-issues

ここ見ると、重複しているissue上げないでねって書いてますが、ドキュメント明らかに間違ってるので、
今回は気にしなくて良いと思います。

リポジトリによっては、セキュリティの問題とかはissueにいきなり書かずにメールで開発元にフィードバックしてください。みたいな話があるので、どこにフィードバックするかは気にした方が良いと思います。リポジトリのどこかに書いてあることもあります(ないこともありますw)。

[tjnet]

適当に検索しましたが、今回のissue(リンク切れ)だとこれくらいのvolumeで十分だと思いますねえ
wootapa/watable#34

[tjnet]

正直、英語は通じれば良いと思います。僕も英語苦手ですが、ちゃんとフィードバック返ってくるので、、

[Taillook]

"Other Linker Flags" in https://github.com/rs/SDWebImage#installation-by-cloning-the-repository is link expired.
Want more information.

[tjnet]

"Other Linker Flags" in https://github.com/rs/SDWebImage#installation-by-cloning-the-repository is 404(not found).
where should I access to see latest document?

[tjnet]

issueタイトルは "Other Linker Flags" setting is not found とか、、

[tjnet]

ひとつ貢献しちゃいましたね、、、すごい!
"Other Linker Flags" setting is not found · Issue #2012 · rs/SDWebImage

[Taillook]

"Other Linker Flags" setting is not found

New Issue Checklist

• I have read and understood the CONTRIBUTING guide
• I have read the Documentation
• I have searched for a similar issue in the project and found none

Issue Description

"Other Linker Flags" in https://github.com/rs/SDWebImage#installation-by-cloning-the-repository is 404(not found).
where should I access to see latest document?

というissueを出した

[tjnet]

簡単に取り組めそうなissueがあったのでPull Requestを出してみようという話になりました。
"yes". boolValue -> false · Issue #863 · SwiftyJSON/SwiftyJSON

テスト書きましょう、というお話をしました。

PRのタイトルはこれにする？
When using "yes".boolValue , return false

[Taillook]

”When using "yes".boolValue , return false”
こんな感じですかね

[tjnet]

そうですね。descriptionは、、こんな感じ？
ReactiveCocoa/ReactiveSwift#496

[tjnet]

タイトルはWhen using "yes".boolValue , return trueにしましょう。falseだと意味おかしいw

[Taillook]

"When using "yes".boolValue , return true - issue #863"

これにします

[Taillook]

SwiftyJSON/SwiftyJSON#884
プルリクを出しました

[piroor]

躓いた所を見逃さずにフィードバックに繋げたことが何より素晴らしいです！
ちゃんとテンプレートを見付けてきて使ってきたのも良いです。（自分は諦めてフリースタイルでやってしまいがち）

口頭で述べたこと：

• 躓いた「理由」「動機」の記述があると、見る側もアドバイスをしやすくなります。報告の内容にも、動機が書いてあると「その使い方は想定していなかった」や「その動機ならこの機能を使うのが適切」といった誘導を受けられることが期待されます。
• 今回のissueとPRは「実際に起こっていること」と「PR後に起こること」をそのまま表現していますが、issue, PRのタイトルでは自分は「XXX should return YYY」のような表現を使うことが多いです。これだと、期待される状態と実際の状態があるということ、その実際の状態は期待される状態に反しているという文脈が読み取りやすくなるかなと思っています。

[kou]

お疲れ様でした！

12月5日（火）の夜にここ3ヶ月くらいのOSS Gateの活動をふりかえる機会があります。
OSS Gateふりかえり2017-12

ふりかえる材料として高専生・学生向けに実施したOSS Gateワークショップ参加者が感じたことがあると助かるので、ぜひ12月5日までに https://github.com/oss-gate/retrospective/issues/new から感じたことを登録してください。「よかったこと」、「困ったこと」という分類で書いていますが、分類は気にせずに感じたことを書いてもらえれば大丈夫です。あとで、こっちでまとめて https://github.com/oss-gate/retrospective/projects/4 から見えるようにします。

これからも引き続きOSSの開発に参加していきましょう！