GitHubを活用した輪読会開催法

[Seasawher]

@aconite-ac

lean-ja 設立により、輪読会や勉強会が開催しやすくなったと思うので、活用していきたいと思っています。

輪読会はleanなしだとノートを共有したりして開催しますが、lean と github を前提にするとプルリクエストベースの輪読会もできるのではないかと思います。

たとえばmathematics in lean を輪読するとして、

1. 担当を決める
2. 担当者は、担当箇所についてsorryを埋めて、プルリクエストを投げる
3. 参加者全員でレビューして、議論がなくなったらマージする
4. 以上を繰り返す

という方法が取れるかなと思います。
この方法だと全員の予定合わせをきっちりする必要がなく、開催しやすく継続させやすいという利点があると思います。

どうでしょうか？

[aconite-ac]

なるほど、ノートの共有をプルリクエスト→レビュー→マージという過程で再現するのですね！
leanファイルを使う輪読会として、合理的な開催法なのではないかと思います。
仰るように、ファイルの管理が楽・対面のように時間と場所を合わせる必要がないなど、様々な利点がありそうですね。
実際、まずMathematics In Leanの輪読から始めるのが良さそうな気がします。

[Seasawher]

Mathematics in Lean の日本語訳もいつか作りたいので，こういう形式で作れたらいいなと思っています

[Seasawher]

@haruhisa-enomoto いかがでしょう？

[aconite-ac]

1. Discussionタブに「募集」カテゴリを設ける、あるいは「アンケート」カテゴリを使う(どちらかというと前者がよさそう？)。
2. 募集をかける(＋Discordに募集へのリンクを貼る)。
3. 人が集まったら企画をスタートさせる。

という募集手順のテンプレートを作るのがいいと思います。
まず、MILの輪読をこの手順で始めれば(必要そうなら「お知らせ」カテゴリでも手順を共有すれば)、
他の企画を始めたい方も募集の手順が分かると思います。

(MILの輪読について、自分は現時点では不参加とさせてください…。募集も他の方がして頂けるとありがたいです。)

[s-taiga]

募集手順のテンプレートについてもそれをまとめたリポジトリがあると良さそうですね！
個人的にそれに加えて輪読会・勉強会でまとめる文書の形式（mdbookで作っていくのか、leanファイルにコメントを入れてmd等に変換するツールを使うのかを統一すると今後やりやすいのではないかと思っています）もまとめておくとよいような気がしています。
もしこちら良さそうでしたら自分の方で作成してみたいと思っていますがよろしいでしょうか？
（このような場でのリポジトリの作成等をしたことがないので、こういうタイミングで練習できれば……と思っています）

[Seasawher]

@s-taiga

MIL の輪読は我々 + 希望者でやりましょうか．

---

募集手順のテンプレートについてもそれをまとめたリポジトリがあると良さそうですね！

確かに，GitHubの運用方法をまとめた文書がどこかにまとまっている必要がありますね

GitHub Organization の機能として提供されている可能性が高いと思って調べていたのですが，調べ切れておらず，見つけてはいないものの「提供されていない」とは断言できない…という状態です．

たとえば，ディスカッションにテンプレートを設定する機能があったりするので，それを活用できる可能性はあります．また，リポジトリごとに Wiki を作る機能もあるので，それを用いて .github リポジトリに wiki を作ってもいいかもしれません．

もしよろしければ，そのあたりの調査からしていただけると助かります．私も調べたいのですが，ほかの作業が終わらないので…．

もし時間がかかりそうであれば，テンプレートの作成はまた次回ということにして，告知だけするのもいいかと思います．aconite さんのおっしゃるように，discussion に「勉強会告知」というようなカテゴリを作成して，そこと discord で告知するというのがよさそうに思います．

個人的にそれに加えて輪読会・勉強会でまとめる文書の形式（mdbookで作っていくのか、leanファイルにコメントを入れてmd等に変換するツールを使うのかを統一すると今後やりやすいのではないかと思っています）もまとめておくとよいような気がしています。

MILのようにテキストがある場合は，そのテキストが使用しているツールを使うのがいいと思います．

勉強会のようなオリジナルのテキストの場合は，まだそれをまとめられるほど知見が蓄積されていない気がします

[s-taiga]

調査についてかしこまりました。ひとまず本日中に調べてみようと思います。
そこで有益な情報を見つけきれませんでしたらおっしゃる通りテンプレートの作成は次回とさせていただきたく思います。
また変換ツールについてもおっしゃる通りだと感じました。ありがとうございます。
ちなみに輪読会について参加するつもりではあるのですが、現在仕事が若干立て込み気味であるので進捗は遅めになるかもしれません。。

[Seasawher]

ありがとうございます！

[s-taiga]

@Seasawher
調査と輪読会用の設備について検討してみました。
まず用意するものとして、募集用のディスカッションのテンプレートと勉強会用のProjectsを作成したいです。
Projectsという機能で複数ブランチでのissueやプルリクエストをまとめて管理し、またProjects自体にもREADMEの作成が可能でしたので勉強会関連全体の情報集約に向いているのではないかと考えています。

上記を用いたうえで、自分の方で今考えています輪読会開催までの流れは以下の感じです。
1．ディスカッションにて輪読会の参加募集を投稿（DiscordやTwitterにこのディスカッションのURLを投稿？）
2．開催が決定した場合、輪読会対象のリポジトリを作成する
3．リポジトリのプロジェクトで勉強会用のプロジェクトをリンクする
4．リポジトリのリンクを参加者に共有する
この手順等をProjectsのREADMEに記載しておく想定です。

また募集用のディスカッションのテンプレート内容として以下を考えてみました。

title: "輪読会[書籍タイトルを記入]"
label: "[アンケート]"
body:
  - type: markdown
    attributes:
      value: |
        以下の書籍の輪読会を検討しています。参加を希望される方は本投稿にgoodのリアクションをつけてください。
  - type: textarea
    id: book_name
    attributes:
      label: 書籍名
  - type: textarea
    id: book_repository
    attributes:
      label: リポジトリのパス

以上、内容ご確認いただけますと幸いです。
それからテンプレートの登録について、自分に権限が無いみたいでして自分の方からテンプレートの登録ができないようでした。（できる場合はディスカッションのカテゴリー一覧の上に編集マークが出る見たいですが見当たりませんでした。）

[s-taiga]

@haruhisa-enomoto @aconite-ac
すみません、調査のお話をしていたためKitamadoさんにのみメンションしていましたが、お二方にも内容ご確認いただけますと幸いです。
お手数をおかけしますが、よろしくお願いいたします。

[Seasawher]

@s-taiga 調査ありがとうございます．返信が遅れて申し訳ないです．

まず用意するものとして、募集用のディスカッションのテンプレートと勉強会用のProjectsを作成したいです。
Projectsという機能で複数ブランチでのissueやプルリクエストをまとめて管理し、またProjects自体にもREADMEの作成が可能でしたので勉強会関連全体の情報集約に向いているのではないかと考えています。

ありがとうございます．ぜひやってみていただきたいです．

上記を用いたうえで、自分の方で今考えています輪読会開催までの流れは以下の感じです。

1点気になったのですが，勉強会の参加者は lean-ja のメンバーでなくても良いという想定でしょうか？

それなら勉強会用のリポジトリは public にする必要があるので，勉強会用のリポジトリを作成すると同時にlean-jaのフォロワのTLに流れます．

リポジトリを作るときに，「勉強会用のリポジトリで，これからコードが追加されていくものだし，教材として使われるものではないし，日本語訳でもない」ということが明らかになるような名前を考えた方がいい気がします．prefix として、seminar- をつけるのはどうでしょうか．

また，人数が多いと通知を飛ばすためにメンションするのが面倒なので，4人以上いる時は勉強会用の team を作ることを検討してもいいかもしれません．その場合は，参加者にも lean-ja のメンバーになっていただいた方が都合がいいと思います．

また募集用のディスカッションのテンプレート内容として以下を考えてみました。

リアクションだと通知が来ないので、リプライをつけてもらった方がいいかもしれません．

それからテンプレートの登録について、自分に権限が無いみたいでして自分の方からテンプレートの登録ができないようでした。

よく確認してしておらず申し訳ないです．s-taiga さんは立ち上げにあたり最初から関わってくださっていたので owner 権限を差し上げた方がいいかもしれません， 念の為に @aconite-ac さんにも意見を求めたいです．

一般的には，メンバーに権限を与えたいときに毎回 owner にするのはよくない運営の仕方だと思うので，ちょうどいい権限セットを持った team が必要という気がしますね．

---

とり急ぎ．

[s-taiga]

遅くなりましてすみません。
ご確認ありがとうございます！

1点気になったのですが，勉強会の参加者は lean-ja のメンバーでなくても良いという想定でしょうか？

この点自分も気になったのですが、ドキュメントをさっと読んでみた感じ特にそのようなアクセスの制限にかかわる記述が無いように見えましたので多分大丈夫なのではないかと思っています。。

リポジトリを作るときに，「勉強会用のリポジトリで，これからコードが追加されていくものだし，教材として使われるものではないし，日本語訳でもない」ということが明らかになるような名前を考えた方がいい気がします．prefix として、seminar- をつけるのはどうでしょうか．

こちらとても良い気がしました！
READMEに記載しようと思います。

リアクションだと通知が来ないので、リプライをつけてもらった方がいいかもしれません．

確かにおっしゃる通りだと思いましたのでこちらも記載修正します。

[Seasawher]

また，人数が多いと通知を飛ばすためにメンションするのが面倒なので，

よく考えたら、勉強会の参加者に当該リポジトリをwatch してもらえば済みますね

原則としてメンバーでなくても何の問題もなく勉強会に参加できるというルール設計が良さそうです

[Seasawher]

@aconite-ac @s-taiga @haruhisa-enomoto

権限の話ですが，メンバーのデフォルトの権限 (Member privileges / Base permissions) が READ になっているのが多分原因だと思います．

Write に変えておきましょう．

また，メンバーのデフォルトの権限が強くなるので，メンバーになっていただく方は lean-ja のOSS活動に開発者として貢献したい（してもらいたい）という方だけに限るのが良いと思います．

@s-taiga

すみませんが，権限を変えたのでもう一度試してもらえませんか

[s-taiga]

権限変更ありがとうございます！変更できそうです！

[s-taiga]

ひとまずプロジェクト作成しました。
https://github.com/orgs/lean-ja/projects/1/views/1
右上のopen project description panelを押下するとREADMEを閲覧・編集が可能です。

ディスカッションのテンプレートについても.githubリポジトリにファイル追加したいと思うのですが、プルリクエストを出す感じがよいですよね？
（実をいうとGitHubでプルリクエストを出すのも初めてなので見当違いなことでしたら申し訳ありません。。）

[aconite-ac]

@lean-ja
輪読会の枠組み作り・権限に関する検討をしていただきありがとうございます！

1. 権限について

   • 適切なOwner人数・信頼性・公平性を鑑みた結果、
     『Owner権限を持つ人 ⇔ 現時点でcode for mathのスレッド「Leanの日本語コミュニティ」に参加していて、
     かつ本人の同意が得られた人』とするのが丁度良いと思いました。
     今回の編集に必要な権限の付与はデフォルトの権限変更によって解決できたと思われますが、
     @Seasawherさんからの提案もありましたし、@s-taigaさんにOwner権限を付与しようと思います。
     → リスク管理のためOwner権限付与者はごく少数が良いというご指摘を受けましたので、
     基本的に権限は最小限とし、必要な作業ができない場合(必要な作業ができないと想定される場合)
     に都度検討するという方針を取ろうと思います。

   • 今後、特別な状況にならない限り、Owner権限は付与しないという方針がよいと思います。

   • 今後、Aさんを開発者としてのメンバーに追加する場合は、

     1. デフォルトの権限をWriteにし、Member権限を付与する
     2. デフォルトの権限をReadにし、Member権限を付与し、Teamを使って権限を管理する

     のいずれかを採用するのがよいと思います。

   権限については様々な意見が考えられ、またGitHubのTeam機能について理解が不十分な点もありますので、
   Memberの方々からご意見ありましたら参考にさせていただきたく思います。

2. 輪読会の枠組みについて
   ProjectsとDiscussionのテンプレートを活用するという、現段階での方針に賛成です。
   「メンバーでなくても何の問題もなく勉強会に参加できるというルール設計」は必須だと思いますので、その確認はしようと思います。

[aconite-ac]

失礼しました、迅速なご指摘ありがとうございます。
(元の文面は誤解されにくい形に修正したのち再公開します。)

[s-taiga]

今githubにログインしてない状態でプロジェクトを見てみましたところ勉強会のプロジェクトの参照ができませんでした。。
再度確認してみましたところ、Owner権限のある方からプロジェクトのPublic/Privateを切り替えられるようで、現在Privateになっているのが原因のようでした。
お手数をおかけしますが、どこかのタイミングで変更いただけますと幸いです。

[Seasawher]

@s-taiga さんが作成したプロジェクトなので，s-taiga さんが admin 権限を持っていると思っていたのですが，勘違いしていたようですね

権限まわりで面倒をおかけしておりすみません…．

[s-taiga]

いえ、こちらもよくわからないままお願いしてしまったところが大きいと思いますのでお気になさらないでください！
ともあれあとディスカッションのテンプレートの登録までできれば明日にでも告知できればと思います！

[aconite-ac]

親コメントの文面を修正した上で再公開しました。
権限の取り扱いについて経験がなく、不適切な対応をとってしまい大変申し訳ありません。

[Seasawher]

@s-taiga

s-taiga さんはプロジェクトの管理者になっています．また，プロジェクトの管理者はプロジェクトの可視性を変更できるはずです．

プロジェクト管理者と Organization 所有者は、プロジェクトの可視性を制御できます。 Organization 所有者は、プロジェクトの可視性の変更を Organization の所有者のみに制限できます。

https://docs.github.com/ja/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects#about-project-visibility

おそらく organization owner しか変更できない設定にしてしまっているようなので，変更しようと思います

[Seasawher]

変更しました！！もう一度試してみてください

https://github.com/orgs/lean-ja/discussions/17

[Seasawher]

@s-taiga ところで Project のREADMEですが，ちょっと見づらい場所にありますね

リポジトリのREADMEのように，アクセスしたら見逃しようのない場所に即表示されるのかと思っていましたが，ちょっと隅の方にあって，しかもクリックしないと見えないですね

もっと見やすい場所に情報がまとめられると尚よいと思いましたが，どうでしょうか？

[Seasawher]

@s-taiga

ディスカッションのテンプレートについても.githubリポジトリにファイル追加したいと思うのですが、プルリクエストを出す感じがよいですよね？

お返事が遅くなってしまってすみません．そうですね，プルリクエストを出してくださるようお願いします．

ただ，最低でも教材だけ指定すれば募集が成立してしまい，必須の入力事項が少ないため，「募集」カテゴリをディスカッションに新設するだけで運用できる気がし始めました．（議論をひっくり返してしまってすみません）

[Seasawher]

MIL より軽めのなら参加できるかもしれません

追記。単に進捗速度を遅くすればMILでも参加できますね…。勘違いしてました

[s-taiga]

プルリクエストの方マージありがとうございます！ただ今見てみましたらymlの記載どこか間違っていたみたいでテンプレートが反映されませんでした……
また、新たに募集カテゴリを作るため、テンプレートもそちら用にしたいと思いますので再度プルリクエスト出したいと思います。
（あるいは何度か試行錯誤するかもしれませんので、問題なければ自分の方でマージしてしまっても大丈夫でしょうか？）

また輪読会の参加についてはDiscordの方でも募集をしたいと思っていますので、ご無理をなさらずです！

[Seasawher]

あるいは何度か試行錯誤するかもしれませんので、問題なければ自分の方でマージしてしまっても大丈夫でしょうか？

確かにプッシュしないとテストもできませんので、マージまでお願いします。

[s-taiga]

ただいまテンプレートの登録行いました（かなり手こずりまして5回もプルリクエストを作りまして失礼しました……）
そうしましたらMILのリポジトリをlean-jaにフォークしてから募集のDiscussion投稿させていただきます。

[Seasawher]

承知しました！