OSS Gateワークショップに参加して、RedashにPullRequestを出しました

Pocket

はじめに

yoshitaku_jpです。

今回は2018/03/10にOSS Gateさんが主催している
OSS Gateワークショップに参加してきたので参加レポです。

OSSに貢献していきたいなと思いつつなかなか手が出せなかったので、
今回のワークショップを通じて貢献していきたいと思い申し込みました!

OSS Gateとは

  • OSS Gateとは
    • OSS開発に参加していない人が参加する人に変わる「入り口」を提供する取り組み
    • 今回のワークショップはOSS開発参加者を増やす方法の1つとしておこなっている
  • 開催タイミング
    • 1月と4月と7月と10月は最終土曜日に10:30から17:00で開催している
    • 3月と6月と9月と12月は第2土曜日に13:00から19:00で開催している。ワークショップ後に希望者のみ参加の懇親会がある。
  • 想定の参加者
    • ビギナー
      • OSSの開発に参加したいけどまだ参加したことがない人
      • OSSの開発に参加したことはあるけどまだ自信がない人
    • サポーター
      • OSSの開発に参加している人
  • 詳しくはこちら
  • Doorkeeperで参加者を募集している

やること

  • OSSを動かす
    1. 対象のOSSを決める
    2. 作業メモを書く場所を用意
    3. 作業メモを書きながら、公式サイト・READMEを見て動かす
  • 気がついたことをフィードバックする

ビギナーとサポーターの1対1でワークショップはおこなっていきます。
今回担当してくださるサポーターの方はゴさん!

前半の部

対象のOSSを決める

今日はredashを扱ってみることにした。理由は、
– Pythonで書かれていること
– BIツールであること
– 周りで使っている人が多くいること

という観点で選びました。

作業メモを作る

  • URLをメモする
  • 期待する効果をメモする
  • これがあったら良いなとおもったことをメモする
  • 躓いたところをメモする

今回の作業メモはここにあります

業務中にも作業を一つ一つメモすることはやりたいと思いつつ、
なかなか実践できないことである。やはり忘れてしまう…
今回はゆっくり進めて、サポーターの方々の「こういうふうなところをめもしたほうがいいよ」や「ここは躓かなかった?」といった突っ込みもありつつ、丁寧にメモをとることが出来たように思う。

作業メモを書きながら、公式サイト・READMEを見て動かす

今回はOSSの活動に慣れてもらうということで、
作業メモを書きながら、公式サイト・READMEを見ながら、インストールからはじめました。

黙々と作業している中で、躓いたことがありました。
今回はdockerを使ってredash環境を作ろうと思ったのですが、
このページの説明にはredashをローカル環境に落としてくることが明記されていませんでした。

2つ前のページには
「Make sure your current working directory is the root of this GitHub repository.」
と書いてあるのですが、手順としてgit cloneすることはどこにも書いていませんので、ここはコントリビュート出来るポイントかなと思いました。
作業メモに書いておきます。

無事にgit cloneしてdocker-compose upをおこない、redashにアクセスしたところでエラーが発生。
しかし、ここで前半の部が終了しました。

前半の振り返り・フィードバック

振り返りで
– docker-compose upをするためのgit cloneが必要なことが明記されていないことがコントリビュート出来るポイント
– New developer guideがあるので、そこに賛同するコメントをすることも良いこと

後半の部

気がついたことをフィードバックする

後半は気がついたことを実際に開発者たちへフィードバックすることでした
フィードバックする上で大切なことは
– 自分の伝えたいことを整理する
– 開発者にとってわかりやすくなるように編集する
– 適切な場所に報告する

自分の伝えたいことを整理する

docker-compose upをするためのgit cloneが必要なことが明記されていないことが
他の初心者も困ってしまうのかもしれないので、記述してほしい旨を伝えることにする。

開発者にとってわかりやすくなるように編集する

まずは日本語で

redashをクローンする

まずはredashをGitHubからクローンする

git clone git@github.com:getredash/redash.git
cd redash/

英語にしてみた

Git Clone Redash

At the beginning clone Redash from GitHub

git clone git@github.com:getredash/redash.git
cd redash/

サポーターの方がシャンハイ出身の方で、バリバリの英語の添削が入りました笑
– 一番上のところはコマンドを書くわけではないので、一旦やめてみる
– 他の項目が動詞から始まっているので、動詞で初めてみる
– Prepare The Source code とか
– 説明文も、コマンドを繰り返す必要がなく、何をするのかを簡潔に説明する
– Firstly, you need to setup the source code directory from the official repositoryとか

Prepare The Source code

Firstly, you need to setup the source code directory from the official repository.

git clone git@github.com:getredash/redash.git
cd redash/

適切な場所に報告する

今回どこに報告するべきか迷ったのですが、
サポーターのゴさんが、
redashのホームページがgithubで管理されていると教えてくれて、
こちらにプルリクエストを出すことにしました。

redashに対してpull requestをしてみた
https://github.com/getredash/website/pull/65

後半の振り返り・フィードバック

  • git プロトコルをあまり使うべきではない
    • httpsのほうがいい
  • なぜ必要になったのかの説明を書いたほうがいい
    • 人によっては聞かれる
  • コミットメッセージをもっと伝わりやすく

まとめ

  • 常にメモをする
    • 詰まったところに気づくため
  • ソースコードをいじるのだけがOSSではない
  • サポータの方々が一生懸命支援してくれるので本当にありがたい!
  • 個人的な課題
    • gitとgithubの機能をもっと知っていく
    • 英語
    • 英語
    • 英語

ドキュメントを編集するだけでもOSSに貢献しているんだと、ハードルがすごく低くなりました。
改めて常にメモをとることは習慣化していきたいです。
OSS参加のハードルは低くなりましたが、英語のハードルが…
簡単な中学英語でいいと何回も言っていただいたので難しく考えずOSSに参加していければいいなと思います。

OSSのredashに対して、初めてPullRequestも出すことができて大変満足でした!
自分と同じような思いを持っている方がいましたら、ぜひともワークショップへ参加してみてほしいと思います!

次は、もう一回ビギナーとして参加するか、サポーターとしてOSS Gateの活動にも貢献していきたいと思います!

2件のコメント

  1. こんにちは、郷です。

    gitter からこの記事を見ました。吉村さんのブログを見たら、自分も改めてブログをやりたい気持ちが出ちゃった。でも本当にプログラミングが好きですね。

    また git commit message に困ったら、私に送っても大丈夫です。

    1. 郷さん
      コメントありがとうございます。

      自分のブログを見て、ブログやりたい気持ちが出るなんてすごくうれしいです!
      このブログを書いた意味がありました!

      git commit messageは本当に困ることが多く…苦笑
      また頼らせていただきます。

      ありがとうごうざいました。

コメントする

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です