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.6k
オンプレ to オンプレした話/on-premises2on-premises
blue0513
0
2.7k
GitもCIもテストもないプロジェクトでデプロイを自動化するまでの道 / rebuild of DevOps
blue0513
0
2.9k
Git & GitLab & コードレビューって? / about Git, GitLab, CodeReview
blue0513
0
160
ElectronでSlackをさらに便利にしちゃう / Slack with Electron
blue0513
3
630
Emacs × Sound やってみた / Emacs with Sound
blue0513
2
830
Slack を TweetDeck にしてみた件 / slackdeck-proto
blue0513
1
2.7k
知ってるとお得な iTerm2 と zsh/bash の小技
blue0513
3
740
クラウド電子カルテを支える魂の技術
blue0513
0
2.2k
Other Decks in Programming
See All in Programming
Zero Waste, Radical Magic, and Italian Graft – Quarkus Efficiency Secrets
hollycummins
0
230
Micro Frontends for Java Microservices - Devnexus 2024
mraible
PRO
0
490
Snowflakeで眠ったデータを起こそう!
estie
0
120
From Spring Boot 2 to Spring Boot 3 with Java 22 and Jakarta EE
ivargrimstad
0
1.1k
educure_カリキュラム生操作マニュアル.pdf
linew_official
0
740
HUIT新歓2024「競技プログラミング、やってみませんか?」
slephy2784
1
270
try!Swift Tokyo 2024 参加報告 LT
akidon0000
1
220
SwiftUIで使いやすいToastの作り方 / How to build a Toast system which is easy to use in SwiftUI
lovee
3
140
エンターテイメント業界で利用されるAWS
demuyan
0
210
Random\Randomizer クラスで日常のあれこれを解決しよう! / Random\Randomizer class solves familiar trouble
cocoeyes02
0
230
今、知っておきたい! 生成AIエージェントの世界
elith
3
350
Changed Rules: Architectures with Lightweight Stores
manfredsteyer
PRO
0
240
Featured
See All Featured
Designing for humans not robots
tammielis
248
25k
Let's Do A Bunch of Simple Stuff to Make Websites Faster
chriscoyier
501
140k
ReactJS: Keep Simple. Everything can be a component!
pedronauck
659
120k
Code Reviewing Like a Champion
maltzj
514
39k
How GitHub (no longer) Works
holman
304
140k
Refactoring Trust on Your Teams (GOTO; Chicago 2020)
rmw
25
2.3k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
21
1.6k
Bash Introduction
62gerente
604
210k
StorybookのUI Testing Handbookを読んだ
zakiyama
13
4.6k
Stop Working from a Prison Cell
hatefulcrawdad
266
19k
Embracing the Ebb and Flow
colly
80
4.1k
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
17
1.4k
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 ͕ͦΕͬΆ͘ͳͬͨʂ