OSS Gate Workshop: Tokyo: 2017-11-25: cocoeyes02: anaconda: Work log

oss-gate / workshop

OSSの開発に未参加または参加したことはあるけどまだ自信がない人を後押しするワークショップ用のリポジトリー

123 stars 540 forks source link

OSS Gate Workshop: Tokyo: 2017-11-25: cocoeyes02: anaconda: Work log #667

Closed cocoeyes02 closed 6 years ago

cocoeyes02 commented 6 years ago

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の開発に参加しましょう！
シナリオ：ワークショップの目的・内容・進め方の詳細が書いています。
過去のビギナーの作業ログ：他の人の作業ログから学べることがいろいろあるはずです。

swamp09 commented 6 years ago

サポーターの沼田です。よろしくお願いします！

cocoeyes02 commented 6 years ago

よろしくお願いします！ LICENSEを確認 https://github.com/ChimeraCoder/anaconda/blob/master/LICENSE

cocoeyes02 commented 6 years ago

まずはREADME.mdを眺めてみる https://github.com/ChimeraCoder/anaconda

cocoeyes02 commented 6 years ago

README.mdの文章中にリンク切れが存在する

cocoeyes02 commented 6 years ago

リンク切れの箇所をblameで見ると、更新が5年前なのでその間にURLが変わっていた可能性がありそう

cocoeyes02 commented 6 years ago

リンク切れと正しいURLっぽいもののまとめ

誤：https://developer.twitter.com/docs/rate-limiting/1.1 正?：https://developer.twitter.com/en/docs/basics/rate-limiting

誤：https://developer.twitter.com/docs/api/1.1 正?：https://developer.twitter.com/en/docs/api-reference-index

cocoeyes02 commented 6 years ago

実際にanacondaをcloneしてみて、httpなどURLに関連しそうなワードで全文検索して見る →ソースコードのコメントに書いてあるURLにもリンク切れURLがたくさんある

cocoeyes02 commented 6 years ago

このコメントにあるURLのリンク切れが他に影響しているか判断する方針としては、

実装に影響しているかどうかソースを読み解く
他に出ているissueを見て、関連したバグ等がないか見る

cocoeyes02 commented 6 years ago

関連したissue、Pull Requestはぱっと見ではなさそう

cocoeyes02 commented 6 years ago

実装もぱっと見では問題ないように見える（実際の使用しての確認はまだしていない）

cocoeyes02 commented 6 years ago

色々なファイルに書いてあるURLがリンク切れしている趣旨のissueを投げれば良さそう

cocoeyes02 commented 6 years ago

これはこのURLであると言う確証があるものがあればその部分はPullRequestで出してあげる。
- ドメイン等がどう変わったのかを示してあげると良い。
そうでない部分はリンク切れに対して正誤表を作成し、issueを立てて貼り付ける。
- その後、開発者のコメントを待ち対応する。

cocoeyes02 commented 6 years ago

ソースコードを更に読んでみての整理

READMEのリンク切れはドメイン、エンドポイントを含めて違うリンク切れである
ソースコードのコメントに書いてあるURLのリンク切れは複数パターンある
- ドメイン、エンドポイントを含めて違うリンク切れ
- エンドポイントのみが違うリンク切れ

cocoeyes02 commented 6 years ago

ソースコードを1つ例でみて見る

//SetActivityWebhooks represents to set twitter account_activity webhook
//Registers a new webhook URL for the given application context.
//The URL will be validated via CRC request before saving. In case the validation fails,
//a comprehensive error is returned. message to the requester.
//Only one webhook URL can be registered to an application.
//https://api.twitter.com/1.1/account_activity/webhooks.json
func (a TwitterApi) SetActivityWebhooks(v url.Values) (u []WebHookResp, err error) {
    responseCh := make(chan response)
    a.queryQueue <- query{a.baseUrl + "/account_activity/webhooks.json", v, &u, _POST, responseCh}
    return u, (<-responseCh).err
}

この実装だと、ドメイン変わっていてもエンドポイントが変わっていなければ問題なく動く
ただし、エンドポイントが変わってしまうとこの関数自体が動かなくなる可能性がある

cocoeyes02 commented 6 years ago

動作の方に影響があるかどうか判断するのは実際に使ってみないとわからないので、今回はリンク切れの報告のみに止める

cocoeyes02 commented 6 years ago

リンク切れしているURLとファイルのリストアップを始める

cocoeyes02 commented 6 years ago

合っていそうなURLが分かっているものはプルリクを出す方針にする

cocoeyes02 commented 6 years ago

基本的にリンク切れのURLの内容はTwitter公式ドキュメントを指し示すものだったので、現状のドキュメントを見ながら正しいURLを入力していった

プルリクを出した。ありがとうございました。 https://github.com/ChimeraCoder/anaconda/pull/227

ghost commented 6 years ago

https://gitlab.com/meno/dropzone/merge_requests/28

knokmki612 commented 6 years ago

おつかれさまでした！ PRがマージされてますね！よかったです！！！

一旦クローズしますが、引き続きこのissueを作業に使っても大丈夫です！

直近の東京で開催されるOSS Gateのイベントは以下のとおりです！

12月5日: OSS Gateふりかえり2017-12
12月18日: 東京ミートアップ
1月27日: 東京ワークショップ

是非よかったらまた参加してみてください！