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.7k
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
3k
オンプレ to オンプレした話/on-premises2on-premises
blue0513
0
3.1k
GitもCIもテストもないプロジェクトでデプロイを自動化するまでの道 / rebuild of DevOps
blue0513
0
3.3k
Git & GitLab & コードレビューって? / about Git, GitLab, CodeReview
blue0513
0
240
ElectronでSlackをさらに便利にしちゃう / Slack with Electron
blue0513
3
860
Emacs × Sound やってみた / Emacs with Sound
blue0513
1
1k
Slack を TweetDeck にしてみた件 / slackdeck-proto
blue0513
0
3k
知ってるとお得な iTerm2 と zsh/bash の小技
blue0513
3
850
クラウド電子カルテを支える魂の技術
blue0513
0
2.5k
Other Decks in Programming
See All in Programming
釣り地図SNSにおける有料機能の実装
nokonoko1203
0
200
The Past, Present, and Future of Enterprise Java
ivargrimstad
0
590
開発組織の戦略的な役割と 設計スキル向上の効果
masuda220
PRO
8
1.4k
コード生成なしでモック処理を実現!ovechkin-dm/mockioで学ぶメタプログラミング
qualiarts
0
250
The Past, Present, and Future of Enterprise Java
ivargrimstad
0
190
CSC305 Lecture 10
javiergs
PRO
0
220
alien-signals と自作 OSS で実現する フレームワーク非依存な ロジック共通化の探求 / Exploring Framework-Agnostic Logic Sharing with alien-signals and Custom OSS
aoseyuu
2
280
ソフトウェア設計の実践的な考え方
masuda220
PRO
4
630
AIと人間の共創開発!OSSで試行錯誤した開発スタイル
mae616
2
790
『毎日の移動』を支えるGoバックエンド内製開発
yutautsugi
2
280
What's new in Spring Modulith?
olivergierke
1
170
SwiftDataを使って10万件のデータを読み書きする
akidon0000
0
240
Featured
See All Featured
The Invisible Side of Design
smashingmag
302
51k
Practical Orchestrator
shlominoach
190
11k
Embracing the Ebb and Flow
colly
88
4.9k
Chrome DevTools: State of the Union 2024 - Debugging React & Beyond
addyosmani
9
930
GraphQLの誤解/rethinking-graphql
sonatard
73
11k
Intergalactic Javascript Robots from Outer Space
tanoku
272
27k
Understanding Cognitive Biases in Performance Measurement
bluesmoon
31
2.7k
Documentation Writing (for coders)
carmenintech
75
5.1k
Bootstrapping a Software Product
garrettdimon
PRO
307
110k
Building Applications with DynamoDB
mza
96
6.7k
The Straight Up "How To Draw Better" Workshop
denniskardys
238
140k
Practical Tips for Bootstrapping Information Extraction Pipelines
honnibal
PRO
23
1.5k
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 ͕ͦΕͬΆ͘ͳͬͨʂ