GitHub Badges スタンプラリー2019

1. スタンプラリー
2019
By Yu Otsubo

2. 自己紹介
＊大坪 悠(Yu Otsubo)
＊1993年生まれ 新潟出身
＊本業は音楽活動と思い込んでいる
が一応開発業務でお金を
いただいている
＊同期が次々と結婚していて
内心焦っている
https://www.facebook.com/yu.otsubo
https://github.com/tubone24
https://soundcloud.com/user-453736300
https://tubone-project24.xyz

3. Badgesとは？

4. OSSのGitHubのREADMEに
ぺたぺた貼ってあるかっこいい
感じのバッジ

5. 現在のリポジトリの状態、例えばCIのビルド結果やカバレッジ、ライセンス、依存、
パッケージ管理のバージョン情報などがぺたぺたと
貼ってあるのを見たことありませんか？
[参考] pytest https://github.com/pytest-dev/pytest

6. かっこいい・・・

7. じゃあ個人開発のGitHubリポジトリに
ぺたぺた貼ってみたら
かっこよくなるのでは？

8. やってみた

9. 今回の犠牲レポジトリ
ebook_homebrew くん
GitHub
https://github.com/tubone24/ebook_homebrew
Read The Docs
https://ebook-homebrew.readthedocs.io

10. その前に

11. READMEを英語に

12. 英語にするだけでもOSS感出ますね
お作法があるのか知らないですが、
イラスト⇒区切り線⇒タイトル⇒インストール方法・・・と構成するらしいですね

13. 大雑把に Badgesを分類

14. CI

15. 単純なビルド結果の他
パスしたテストケース数、
カバレッジ、品質スコア、実行環境別など
CIによって使えるBadgeは全然違う
（一番かっこいいBadgeはCircleCIかな、CIとしてどのCIが優秀か談義は後ほどしましょう・・・）

16. 注意点

17. ビルド結果によって
failed になると
恥ずかしい・・・

18. CI側の変更や、大量のJobがキックされキュー
落ちしたりでfailedになることは結構ある
古いレポジトリだと有名なものでもたまに赤くなってます

19. こんなテンションで
進みます
OK？

20. カバレッジレポート

21. CIで実行したテストのカバレッジレポートファイ
ルをパイプライン内で送ってあげることで
カバレッジの推移を見ることが出来るサイトに
アクセスできるBadgesが手に入る
CIに上記機能があるものもある
（有名どころ: Codecov, Coverall, CodeClimate）

22. 静的コード解析

23. おそらくBadgesでもっとも個性がでるので
是非使いたい
PRに追従して静的コード解析してくれるが、
個人で開発しているとだんだん
うっとうしくなるのが課題
（一番ザルなのはScrutinizer もともとPHP業界で流行っただけある）

24. ドキュメント

25. OSSのきれいな技術文章といえばSphinxを
使ったドキュメント生成、ホスティングサービス
「Read The Docs」
Badgesマニアならがんばってクソめんどい
reStructuredTextを書こう！

26. Contributor向け

27. PRにウェルカムな姿勢や
従って欲しいコードスタイルや
困ったときの相談窓口チャットを
Badgesで示してあげよう
（Badgesで宣言したからにはCONTRIBUTING記載やマメなPRレビュー、チャット解答、自らも
コードスタイルを守るようにしないと恥ずかしい）

28. パッケージ管理

29. Python Package Index (PyPI)などに
パッケージを登録すればご褒美で
Badgesがもらえる
（一応世界に配信することになるので、しっかりいろんな環境でテストし、セマンティックな
バージョンニングに従い、メンテを怠らないこと！それがBadgesマニアに求められる心意気）

30. 依存性チェック

31. snykなど依存・脆弱性を確認することのできる
Badgeもある
Dependabot などREADMEではなく、
PRとして利用パッケージの互換性を示す
Badgeを貼るサービスもある

32. ライセンス

33. ライセンスをしっかり明示しているみんなは
License Badgeを使うことが出来る
GitHubだと、ライセンスファイルは簡単に作る機能があるのでとりあえずMITライセンスで
作っておくのをおすすめします

34. その他

35. 作者に ありがとう をいうプロジェクトのページ
を作るとSay Thanks Badgeをもらえる
ぜひ役に立ったなと思ったら
Say Thanksして欲しい

36. OSS作者にビールお金を
支払うサービス Beerpay
ビールマークのおしゃれなBadgeがある

37. GitHub Issues、PR、Tags、Milestonesと
連携可能なカンバン Waffle.io
Badgeの見た目もすごい特徴的

38. 全部 貼ってみた

40. ？？？

41. 結論

42. 貼りすぎると
クソダサくなる

43. 貼りすぎには気をつけよう！

44. おわり