Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Speaker Deck
PRO
Sign in
Sign up for free
GitHub の README をいい感じにする / Cool Readme
Taiju Aoki
November 08, 2019
Programming
3
1.4k
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.2k
オンプレ to オンプレした話/on-premises2on-premises
blue0513
0
2.3k
GitもCIもテストもないプロジェクトでデプロイを自動化するまでの道 / rebuild of DevOps
blue0513
0
2.4k
Git & GitLab & コードレビューって? / about Git, GitLab, CodeReview
blue0513
0
120
ElectronでSlackをさらに便利にしちゃう / Slack with Electron
blue0513
3
430
Emacs × Sound やってみた / Emacs with Sound
blue0513
2
690
Slack を TweetDeck にしてみた件 / slackdeck-proto
blue0513
1
2.4k
知ってるとお得な iTerm2 と zsh/bash の小技
blue0513
3
600
クラウド電子カルテを支える魂の技術
blue0513
0
2k
Other Decks in Programming
See All in Programming
はてなリモートインターンシップ2022 Web API 講義資料
hatena
0
150
Listかもしれない
irof
1
240
Form実装基本を学び直してみた
hyugatsukui
0
240
Step Functions Distributed Map を使ってみた
codemountains
0
100
AWS App Runnerがそろそろ本番環境でも使い物になりそう
n1215
PRO
0
980
ECテックカンファレンス2023
kspace
1
310
Most Valuable Bug(?) ~インシデント未遂から得た学び~
tatsumiakahori
0
150
Excelの助けを借りて楽にシナリオを作ろう
rpa_niiyama
0
290
PHPDocにおける配列の型定義を少し知る
shimabox
1
130
tidy_rpart
bk_18
0
580
Rust、何もわからない...#6発表資料
ryu19
0
110
Showkase、Paparazziを用いたビジュアルリグレッションテストの導入にチャレンジした話 / MoT TechTalk #15
mot_techtalk
0
110
Featured
See All Featured
Dealing with People You Can't Stand - Big Design 2015
cassininazir
351
21k
What's new in Ruby 2.0
geeforr
336
30k
Facilitating Awesome Meetings
lara
33
4.6k
Helping Users Find Their Own Way: Creating Modern Search Experiences
danielanewman
10
1.3k
Refactoring Trust on Your Teams (GOTO; Chicago 2020)
rmw
22
1.7k
The Illustrated Children's Guide to Kubernetes
chrisshort
22
42k
BBQ
matthewcrist
75
8.1k
Statistics for Hackers
jakevdp
785
210k
Writing Fast Ruby
sferik
613
58k
Keith and Marios Guide to Fast Websites
keithpitt
407
21k
Designing the Hi-DPI Web
ddemaree
273
32k
GraphQLの誤解/rethinking-graphql
sonatard
39
7.8k
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 Λॻ͚Α͍  Custom
Badge  Release Version /github/v/release/:user/:repo /travis/:user/:repo , etc ...
README ʹ Badge ΛՃͯ͠Έͨ 36 GitHub Actions ͷ߹ɺshields.io ΛΘ͍͚ͣΔ 
Jest  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 ͕ͦΕͬΆ͘ͳͬͨʂ