Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
GitHub の README をいい感じにする / Cool Readme
Search
Taiju Aoki
November 08, 2019
Programming
3
1.6k
GitHub の README をいい感じにする / Cool Readme
LT for M3 TechTalk
Taiju Aoki
November 08, 2019
Tweet
Share
More Decks by Taiju Aoki
See All by Taiju Aoki
本番運用中 Oracle を破壊してしまった話 ~ 破壊と創世 ~ / Oracle Destruction and Creation
blue0513
0
2.8k
オンプレ to オンプレした話/on-premises2on-premises
blue0513
0
2.8k
GitもCIもテストもないプロジェクトでデプロイを自動化するまでの道 / rebuild of DevOps
blue0513
0
3k
Git & GitLab & コードレビューって? / about Git, GitLab, CodeReview
blue0513
0
200
ElectronでSlackをさらに便利にしちゃう / Slack with Electron
blue0513
3
760
Emacs × Sound やってみた / Emacs with Sound
blue0513
1
930
Slack を TweetDeck にしてみた件 / slackdeck-proto
blue0513
0
2.8k
知ってるとお得な iTerm2 と zsh/bash の小技
blue0513
2
770
クラウド電子カルテを支える魂の技術
blue0513
0
2.3k
Other Decks in Programming
See All in Programming
The future of development – Are our jobs getting harder or easier?
hollycummins
1
250
From Subtype Polymorphism To Typeclass-based Ad hoc Polymorphism- An Example
philipschwarz
PRO
0
150
Content Security Policy入門 セキュリティ設定と 違反レポートのはじめ方 / Introduction to Content Security Policy Getting Started with Security Configuration and Violation Reporting
uskey512
1
410
Kaigi on Rails 2024 - Rails APIモードのためのシンプルで効果的なCSRF対策 / kaigionrails-2024-csrf
corocn
5
3.3k
レガシーな Android アプリのリアーキテクチャ戦略
oidy
1
170
Dev ContainersとGitHub Codespacesの素敵な関係
ymd65536
1
120
2万ページのSSG運用における工夫と注意点 / Vue Fes Japan 2024
chinen
3
1.3k
PLoP 2024: The evolution of the microservice architecture pattern language
cer
PRO
0
1.4k
Android 15 でアクションバー表示時にステータスバーが白くなってしまう問題
tonionagauzzi
0
130
詳細解説! ArrayListの仕組みと実装
yujisoftware
0
470
Piniaの現状と今後
waka292
5
1.4k
Amazon Neptuneで始めてみるグラフDB-OpenSearchによるグラフの全文検索-
satoshi256kbyte
4
310
Featured
See All Featured
Reflections from 52 weeks, 52 projects
jeffersonlam
346
20k
Designing for humans not robots
tammielis
249
25k
Principles of Awesome APIs and How to Build Them.
keavy
126
17k
Measuring & Analyzing Core Web Vitals
bluesmoon
1
38
Keith and Marios Guide to Fast Websites
keithpitt
408
22k
Facilitating Awesome Meetings
lara
49
6k
Rebuilding a faster, lazier Slack
samanthasiow
79
8.6k
Refactoring Trust on Your Teams (GOTO; Chicago 2020)
rmw
31
2.6k
5 minutes of I Can Smell Your CMS
philhawksworth
202
19k
Faster Mobile Websites
deanohume
304
30k
The MySQL Ecosystem @ GitHub 2015
samlambert
250
12k
Side Projects
sachag
452
42k
Transcript
GitHub ͷ README Λ͍͍ײ͡ʹ͢Δ @blue_1617
ࢲ୭ʁ blue (@blue_1617) https://blue0513.github.io/show_room/ 2 ‣ ΤϜεϦʔגࣜձࣾ ιϑτΣΞΤϯδχΞ ‣ Emacs,
Ruby, JavaScript ‣ VisualStudio, C# ‣ ےτϨΛ࠷ۙ͡Ίͨ ‣ ମॏ͕4Ωϩۙ͘૿͑ɺՌΛײ͍ͯ͡Δ ‣ ࠓظΦεεϝΞχϝ ‣ ΞϑϦΧͷαϥϦʔϚϯ
GitHub ͷ README Λ͍͍ײ͡ʹ͢Δ
ࠓճͷΰʔϧʂʂ 4
ࠓճͷΰʔϧʂʂ 5 ͳΜ͔ͭ·ΒΜͳ......
ࠓճͷΰʔϧʂʂ 6
ࠓճͷΰʔϧʂʂ 7 ͔͍͍ͬ͜ʂʂʂ
ࠓճͷΰʔϧʂʂ 8 https://github.com/blue0513/slackdeck-proto Project Name, Release Version, DL, ESLint, Jest
Λදࣔͨ͠ Badge Λ README ʹ͚ͭΔ
ඞཁͳཁૉͨͪ 9 README ΛؚΜͩΞϓϦέʔγϣϯ
10 ඞཁͳཁૉͨͪ GitHub
11 ඞཁͳཁૉͨͪ ESLint
12 ඞཁͳཁૉͨͪ Jest
13 ඞཁͳཁૉͨͪ Badge
14 ඞཁͳཁૉͨͪ Badge Jest ESLint GitHub
15 ࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ ‣
ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge ΛՃ͢Δ
README ΛؚΜͩΞϓϦέʔγϣϯ 16 Slack Λ TweetDeck ෩ʹݟΔπʔϧ https://github.com/blue0513/slackdeck-proto
README ΛؚΜͩΞϓϦέʔγϣϯ 17 Slack Λ TweetDeck ෩ʹݟΔπʔϧ https://github.com/blue0513/slackdeck-proto
18 ࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ ‣
ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge ΛՃ͢Δ
19 GitHub Actions https://github.com/features/actions
https://github.com/features/actions GitHub Actions 20 https://github.com/features/actions ৄࡉެࣜΛݟͯ͘Ε͍͞ʂ ‣ CircleCI Travis
ΛΘͣʹ CI/CD Ͱ͖Δػೳ ‣ Linux, Windows, macOS ʹରԠ ‣ 3rd party ͷ Action Λར༻Մೳ ‣ yml Ͱ Workflow ΛఆٛՄೳ ‣ Public Repo: Free! ‣ Private Repo: ैྔ՝ۚੑ
21 ࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ ‣
ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge ΛՃ͢Δ
ESLint Λ CI Ͱಈ͔ͯ͠Έͨ 22 $ touch REPOSITORY/.github/workflows/eslint.yml $ emacs
-nw eslint.yml $ git add --all & git commit -m "add eslint" $ git push yml ΛσΟϨΫτϦʹՃͯ͠ push ͢Δ
ESLint Λ CI Ͱಈ͔ͯ͠Έͨ 23 push ࣌ʹಈ͘ ubuntu Ͱಈ͘ root
directory ESLint !
ESLint Λ CI Ͱಈ͔ͯ͠Έͨ 24 Actions λϒͰ ESLint ͕࣮ߦ͞ΕΔ
25 ࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ ‣
ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge ΛՃ͢Δ
Jest Λ CI Ͱಈ͔ͯ͠Έͨ 26 $ touch REPOSITORY/.github/workflows/jest.yml $ emacs
-nw jest.yml $ git add --all & git commit -m "add jest" $ git push yml ΛσΟϨΫτϦʹՃͯ͠ push ͢Δ
Jest Λ CI Ͱಈ͔ͯ͠Έͨ 27 push ࣌ʹಈ͘ ubuntu Ͱ࣮ߦ Node
͕ೖΔ Jest !!
Jest Λ CI Ͱಈ͔ͯ͠Έͨ 28 Actions λϒͰ Jest ͕࣮ߦ͞ΕΔ
29 ࣍ ‣ README ΛؚΜͩΞϓϦ ‣ GitHub Actions ͱ ‣
ESLint Λ CI Ͱճ͢ ‣ Jest Λ CI Ͱճ͢ ‣ README ʹ Badge ΛՃ͢Δ
README ʹ Badge ΛՃͯ͠Έͨ 30 GitHub ͷ README ͰΑ͘ݟΔ͍ͭ͜ΒΛ......
README ʹ Badge ΛՃͯ͠Έͨ 31 GitHub ͷ README ͰΑ͘ݟΔ͍ͭ͜ΒΛՃ͢Δ
README ʹ Badge ΛՃͯ͠Έͨ 32 https://shields.io/ shileds.io Λͬͯ Badge Λ࡞Δ
README ʹ Badge ΛՃͯ͠Έͨ 33 https://shields.io/ shileds.io Λͬͯ Badge Λ࡞Δ
README ʹ Badge ΛՃͯ͠Έͨ 34 ྫ͑ɺBuild ؔ࿈ͷ Badge ͨ͘͞Μ͋Δ
README ʹ Badge ΛՃͯ͠Έͨ 35 Markdown ʹຒΊࠐΉ߹ɺLink Λॻ͚Α͍ ![logo](https://img.shields.io/badge/SlackDeck-Proto-blue) Custom
Badge ![version](https://img.shields.io/github/v/release/blue0513/slackdeck-proto) Release Version /github/v/release/:user/:repo /travis/:user/:repo , etc ...
README ʹ Badge ΛՃͯ͠Έͨ 36 GitHub Actions ͷ߹ɺshields.io ΛΘ͍͚ͣΔ ![jest](https://github.com/blue0513/slackdeck-proto/workflows/jest/badge.svg)
Jest ![eslint](https://github.com/blue0513/slackdeck-proto/workflows/eslint/badge.svg) ESLint https://github.com/{owner}/{repo}/workflows/{workflow_name}/badge.svg)
ͱ͍͏Θ͚Ͱɺ৭ʑ͚ͬͨͲ.....
None
None
None
ࠓճͷΰʔϧʂʂ 41 https://github.com/blue0513/slackdeck-proto Project Name, Release Version, DL, ESLint, Jest
Λදࣔͨ͠ Badge ͕ README ʹ͍ͭͨʂ
·ͱΊ 42 ‣ GitHub Actions Ͱ CI/CD ΛճͤΔΑ͏ʹͳͬͨ ‣ yml
ఆٛʹΑͬͯ ESLint, Jest ͳͲ͕࣮ߦ ‣ Public Repository ແྉ ‣ Shields.io Ͱ Badge Λ࡞Ͱ͖ΔΑ͏ʹͳͬͨ ‣ Repository ͷ༰ΛಡΈऔͬͯࣗಈ࡞ ‣ Custom Badge ͰΦϦδφϧײग़ͤΔ ‣ README ͕ͦΕͬΆ͘ͳͬͨʂ