GitHub Projectを最高のToDo管理ツールにする

2022/09/02に公開約11,900字

この記事はこちらからの引っ越しです

ToDo管理ツール、いろいろありますよね。

古くは Remember the MilkEvernoteGoogle GmailのToDoなども便利です。
しかし、たかだかToDoを管理するのに有料のサービスを使いたくはありませんし、ToDoにはそこそこに個人的なセキュリティが求められる要素があります。

Gmail ToDoだと管理が難しい例

GmailのToDoはメールに起因するToDoには便利ですが、カンバン方式のワークフロー、メールに起因しないToDo…例えば「ああ〜、あのイベントの参加費を月末までに精算処理して領収書提出しなきゃ〜」とか「来月のLTでの講演頼まれちゃったけど、上長伺いから広報チェックから事後記事公開まで 面倒くさい たいへん~」など、チェックボックス的な1段階の階層では片付かないToDoにはあまり効率が良くありません。GmailのToDoは期限もメールそのものへのリンクも保持することができます。また子階層は1階層まで作れますが、だいたい10〜20のToDoが常に存在している状態になると、期限付きのToDo(多くは期限切れのToDo)ばかりが上に行き、新規で作成される期限設定なしのToDoが延々と下に連なって、画面外に行ってしまいます。

エンジニア、もしくは非エンジニアにこそ親しんでほしいGitHubによる個人ToDo管理

ソフトウェアエンジニアであれば GitHub の Issues は慣れ親しんでいるはずです。
このエントリーはその Issues と Projects の Automated Kanban (カンバン方式) を非エンジニアでも ToDo として親しんでしまおう!というコンセプトで書いています。
(よって、プログラミングは一切行いません!)
個人のToDo管理で慣れてくれば、備忘録、読書リスト、クラブやサークル、家族内でのToDo管理などに便利に使えるはずです。また GitHub 公式モバイルアプリもそこそこに使えます。
きっと GitHubの Wiki機能なども便利になってくるはずです。
身近なところから DX を進めていきましょう!

どうやってはじめるの?

必要なものはこちらのパブリックリポジトリに公開しておきました。

https://github.com/kaitas/ToDo

こちらは私自身が自分のリポジトリでフォークして使っている様子です。
ToDoExample.png

カンバン方式なので、左からToDoが生まれ、右に行くにつれ終了に近づいていきます。
通常の Issue と同じく、Closeすれば右に行きますし、私の場合は「今日中に終わらせたい」とか「処理中」とか「待ち!」といった中間のカンバン置き場(column)もあります。
完全に終了したものは「Archive」してアーカイブや「Remove」して削除します。

多くの ToDo は有機的に絡み合っていることがあります。細かなTaskによって構成されている場合も多いですが、Issuesの中でチェックボックス付きリスト - []で列挙することで見やすく管理することもできます。
スクリーンショット 2021-11-14 午前1.32.46.png

他にも Issues や Projects の機能で期限や担当者などを割り当てたりすることもできますが、ここではよりシンプルで幅広い方々に使っていただけそうな使い方について解説していきます。
(面白い使い方がありましたらコメントやプルリクエストで教えてください)

準備(ふだんGitHubを使っている人向け)

準備作業はREADMEにも記載してありますが、とってもシンプルなのです。

  1. このリポジトリをあなたのプライベートリポジトリにクローンします(パブリックリポジトリでテストしてからでいいです)。
  2. .github/ISSUE_TEMPLATE/config.yml を編集して、ユーザー名とリポジトリ名を入力します。custom.mdが実際のテンプレートとしてリンクされます。
  3. Projectsに「MyToDo」のような名前でプロジェクトを作成します。Automated Kanban を選ぶといいでしょう。
  4. Issuesで新しい課題を作成してみてください。custom.md を使ってクールなToDoスタイルのフォームを作ってみましょう。
  5. Projectでオートメーションを設定し、課題のクローズを処理します。
  6. これでもう余計なToDo管理アプリは不要!

ここまで読んでスルッと作業できる人は以下のセクションは読み飛ばして構いません。

非エンジニア向けに丁寧な解説

全体の流れ(初心者向け)

  1. このリポジトリをのこのあたりを見ながら進めます。新規リポジトリを「MyToDo」という名前で作成してください。
  2. .github/ISSUE_TEMPLATE/config.yml を作成して、このファイルを参考にしながらユーザー名とリポジトリ名だけ自分の情報を設定します。.github/ISSUE_TEMPLATE/custom.md が実際のテンプレートとして必要になりますので、こちらもこのファイルを参考にしながら同様に作成します。
  3. Projectsに「MyToDo」のような名前でプロジェクトを作成します。Automated Kanban を選ぶといいでしょう。
  4. Issuesで新しい課題を作成してみてください。custom.md を使ってクールなToDoスタイルのフォームを作ってみましょう。
  5. Projectでオートメーションを設定し、課題のクローズを処理します。
  6. これでもう余計なToDo管理アプリは不要!

さくっと学びたい人向け「フォークについて」

(まずはじめに)GitHub には 公開(オープンソース)のリポジトリであるパブリックリポジトリと、非公開のプライベートリポジトリがあります。リポジトリの右上の「Fork」を使うと、このご用意したリポジトリをフォークして自分のものにできます。
スクリーンショット 2021-11-14 午前1.21.09.png

フォークとは、食事で使う先の割れたフォークのことです。このオープンソースとして公開されているソースを自分の改造を施すために自分の公開リポジトリとしてコピーすることができます(クローンした上で公開)。
実験用途や公開でToDoを管理したいのであればそれで構いませんが、多くの場合、ToDoは個人的な情報を管理することが多いと思いますので、内容を理解したらプライベートリポジトリで作り直すことをお勧めします。

なおリポジトリを後からパブリック→プライベートに変更することもできます。
makeprivate.png
最近のGitHubであれば無料プランでプライベートリポジトリを作れますので大丈夫です。ただ「破壊的な作業」であるので、最後に「ユーザID/リポジトリ名」を打って確認する必要があります。
※「大事な情報をパブリックリポジトリで管理して漏洩した!」といった事故にならないようにお気を付けて。

さて、以下の解説は、新規リポジトリ作成を行った流れで解説します。

(1) 新規リポジトリ「MyToDo」作成

スクリーンショット 2021-11-14 午前1.39.46.png

Repository namePrivate を選ぶところ以外は何も大事なところはありません。
Initialize this repository with: 以下は ReadMeやライセンスを設定するところですが、今回はチェックオフで問題ありません。
これでプライベートリポジトリができあがりました。
続いてコードの追加です。

(2) config.yml と custom.md の作成

.github/ISSUE_TEMPLATE/config.yml の編集には特別なツールは不要です。テキストファイルはブラウザだけで追加編集することができます。
[Add File] からファイル名に .github/ISSUE_TEMPLATE/config.yml と打ってください。最初のドットを忘れずに。スラッシュ「/」を打つと深いディレクトリにファイルを作ることができます。.githubディレクトリは MacOS などでは 見えないディレクトリ扱い なので要注意です。 .github/ISSUE_TEMPLATE というディレクトリは GitHub 上の予約語で、ここに config.yml ファイルを作成して設定を書くことで GitHub 側が自動で処理をしてくれる約束になっています。もちろん無料で利用できます。

blank_issues_enabled: true
contact_links:
  - name: Add new ToDo
    about: made by config.yml
    # edit {username} and {repo} for your environment
    url: https://github.com/kaitas/ToDo/issues/new?template=custom.md&projects=kaitas%2FToDo%2F1&labels=ToDo

最後の行の kaitas となっているところはご自身の GitHub ユーザ名 (https://github.com/ の後ろにあるID)、ToDoのところは先ほど作成したリポジトリ名に置き換えてください。= より後ろにも同じく2箇所あります。 %2F が / に置き換えられるURL文字列になっています。

☆「わからない!」という質問をいただいたので画像で説明します!
config.yml.note.png
↑最後の行のURLに注目です。

nameabout の後ろの文字列は日本語可能です。また # より後ろはコメント行ですので、好きにメモを書いておいて構いません。
編集が終わったら下の[Commit Changes]を押して保存しましょう。
☆この作業は「コミット」といって保存よりも意味が大きいものですが、自分の個人的なリポジトリなので気にせずガンガンコミットしていきましょう。人生にコミットするToDoです。

続いて、同じ ISSUE_TEMPLATE ディレクトリに custom.md というファイルを作成します。
中身はこちら(なくても動きます)

---
name: ToDo template
about: See See .github/ISSUE_TEMPLATE/custom.md
title:  "[DATE]: [FEATURE NAME]"
labels: 'ToDo'
projects: 'kaitas/ToDo'
assignees: 'kaitas'
---


## Description

1. To
2. Do

- [ ] 

これは旧来の GitHub Issues のテンプレートファイルの名残になっているものです。
適当に書き換えていただいて構いません!日本語も使えます
書き換えるためにもまずはコピペで貼り付けて、編集が終わったら下の[Commit Changes]を押して保存しましょう。

(3) Projectsに「MyToDo」を作成する

作成したリポジトリの上部に Projects というタブがあります。新規プロジェクトを作成し「MyToDo」という名前でプロジェクトを作成します。選択肢に Automated Kanbanがありますので選んでください。これは、新しい Issue (課題, この場合は新しいToDo)が終了した場合に次のカラムに自動移動してくれる処理が入る設定です。あとで変更もできます。

(4) Issuesで新しい課題を作成してみてください。

[New Issue] というボタンを押すと、見慣れない画面になったと思います。

スクリーンショット 2021-11-14 午前2.00.46.png
上の ToDo template が旧来の custom.md によるカスタマイズの結果で、下の Add new Todo が今回のおすすめの方法です。 [Open]を押してみるとこんな感じにToDoを作成できます。

例として「イベントの精算をする」というToDoを作成してみます。

スクリーンショット 2021-11-14 午前2.07.43.png

こんな感じの Issue が作成されました。
スクリーンショット 2021-11-14 午前2.10.03.png
GitHubのIssuesに慣れた人であれば、アサインやラベル、マイルストーンの設定もしていいと思います。
ここで「Projects」がきっちり設定されていることに注目です。先程の config.yml の中でURL文字列で設定したプロジェクト名が、自動で設定されるというところがとても嬉しい実装になっているので、慣れてきたら他のプロジェクト(例えば経理とか個人資産とか家族の備忘録とか)を同じリポジトリでプロジェクトを分けてどんどん作ってみるといいと思います。

(5) Projectビュー

スクリーンショット 2021-11-14 午前2.14.49.png
[To Do]のタブの一番下に先程追加した Issue があります。初期に存在するカードは読んだら「…」でRemoveして消してしまって構いません。

チェックボックスをONにすると、タスクが進行します。
スクリーンショット 2021-11-14 午前2.16.45.png
[Close issue] すると自動的にカードが [Done] のカラムに移動します。
スクリーンショット 2021-11-14 午前2.16.56.png
詳細を追記したり、編集したい時は [Go to issue for full details] を押せば、新しいタブで Issueの詳細が開きます。

オートメーションがうまく動いていない時は「Manage」を設定し、課題のクローズ時の処理を設定します。

これでもう余計なToDo管理アプリは不要です!
毎日のToDo管理でGitHubと慣れ親しみましょう!

おまけ

ちなみに、毎日これでToDo管理しているとGitHubのユーザトップページに「草」が生えます。
スクリーンショット 2021-11-14 午前2.21.22.png
これでつよつよエンジニアを証明できるわけではありませんが、毎日の無味乾燥なToDo消化がちょっと楽しくなってくるのではないでしょうか?

ご感想や改造・機能追加などはぜひプルリクエストで教えてください!
(初心者向け解説なので、あまり複雑にはしないのが良いかもですが)
皆様のご感想もお待ちしております

祝!10,000 view & 100 LGTM!

おかげさまで 10,000 view 、そして 100LGTM突破 となりました!
せっかくなので、いくつか追加Tipsを紹介しておきます。

Tips: チェックボックスを使いこなそう

Issues の Markdownを書くときに

と書くと、チェックボックスが作れます。チェックボックスはKanban上では 4 of 15 tasks といった形で達成状況を表示できるので便利です。
tasks.png

Tips: ナイスな Issues を作ろう

上記のチェックボックス化することで、Issueの切り方も変わってくると思います。
多くの「やらなきゃならないこと」に押しつぶされるときは、ToDoが多岐に渡っている上に今すぐ処理できず、さらに複雑に絡まっていることが多いです。これをソフトウェア開発と同じツールで自分宛のIssueにしてみると、意外とナイスなIssueの切り方ができるし、何度も起きそうな案件はテンプレ化して、ちょうどいい時に進めていける感じがします。
自分の場合は、これに加えてGoogle Apps Script (GAS) をよく使用します。何度も起きる案件はスプレッドシートやスクリプトで処理することを考えましょう。特に自分ではなく他者がデータや判断を持っている案件はフォーム化することで解決することは多いです。

Tips: 新しいテンプレを作ろう

.github/ISSUE_TEMPLATE/ のディレクトリには Issuesのテンプレを作ることができます。そしてIssues管理はモバイル版のGitHubでも操作がしやすいのです。
例えばこれはモバイル版Githubで見た「講演を依頼されてから資料公開まで」のテンプレです。

FFXARataUAkj_U_.jpg
コードサンプルとしてはこんな感じです。

---
name: 講演依頼
about: 講演依頼ワークフロー
title:  "講演準備 mm/dd"
labels: 'ToDo'
projects: '(your_id)/my-todo'
assignees: '(your_id)'

---
- [ ] 講演依頼
- [ ] タイトル決定
- [ ] Slack伺い
- [ ] JIRA起票
- [ ] 事前打ち合わせ
- [ ] ゴール設定
- [ ] [Slides準備]()
- [ ] 動画準備
- [ ] 講演当日
- [ ] PDFのSlideShare公開
- [ ] 動画の公開
- [ ] 字幕の修正
- [ ] note等公開

## 講演依頼を貼り付け

GitHub上はこちら

質問などもお気軽にどうぞ!ハッピーToDo管理ライフ!

祝!20,000 view & 200 LGTM!

いつのまにか20,000 view & 200 LGTMを達成していたのですが、ちょっと当惑する出来事がありました。

スクリーンショット 2022-03-20 午前1.22.04.png

あれっ…"test"ってIssue作ってない?あなた誰ですか?
ときどきガチな案件名や詳細が書かれていることがあります。

スクリーンショット 2022-03-20 午前1.22.54.png

ついにアサインをいただきました。

https://twitter.com/o_ob/status/1504905163039215616?s=20&t=xxZoScgXCCMw_5F8K62AKw

おかげでこのエントリーを知ってもらえたので、(怒ったりしないで)よしとしますね・・・。
っていうかリアルタイムでこの手のIssue増えてるのですが…まあいいか、面白いからコミュニケーションとりながら様子みてみよう…。

https://twitter.com/o_ob/status/1504876393389527042

一方でこんなご感想もいただきました。

https://twitter.com/o_ob/status/1505097886379708424

https://twitter.com/o_ob/status/1505098565353639943

便利なテンプレートもあるのですが、Google FormやGoogle Apps Script(GAS)との連携なんかはいい感じですので、また加筆するか、別エントリにしようと思います。

様式美

いつもはメタバースのR&Dの仕事をしています。
技術開発、知財創出、映像制作、講演に執筆、マネジメントなど、やる事の種類や幅が広いのでGithubによるToDo管理はとても役に立っています。

https://twitter.com/o_ob/status/1495062199173541888

ラボのWebサイトはこちらです

https://vr.gree.net/lab/

YouTubeチャンネルぜひ購読してください

https://j.mp/VRSTY

会社のブログ(note)はこちらです

https://note.com/reality_eng/m/m394ac85738b5
こちらも「いいね」やフォロー、シェアしつつ「しらいはかせのqiita役に立ちました!」って言って呟いていただけると、シッポ振って喜びます。
(たぶんつづく)

Discussion

ログインするとコメントできます