Tips for OSS - Speaker Deck

Tips for OSS

by kkeeth

Slide 1

Slide 1 text

Tips for OSS k-kuwahara @kuwahara_jsri @clown0082

Slide 2

Slide 2 text

About me const my_info = { Name: ‘܂ݪ੟ਔ’, Home: ‘૔ෑ, ޿ౡ’, Interest: ‘όεέ, কع, ೔ຊञ’, PokemonGo: ‘TL38’, Workplace: ‘Yumemi Inc’, Skillset: ‘JavaScript, Node.js, PHP, Ruby’ }

Slide 3

Slide 3 text

github.com/riot

Slide 4

Slide 4 text

Publicity

Slide 5

Slide 5 text

https://riotjs-jp.connpass.com/event/95244/

Slide 6

Slide 6 text

Please feel free to join us !! https://riotjs-jp.connpass.com/event/95244/

Slide 7

Slide 7 text

⚠Attention⚠ The code does not appear in this slide❗ I'm so sorry❗

Slide 8

Slide 8 text

Have you ever published a library?

Slide 9

Slide 9 text

I made these two libraries using .

Slide 10

Slide 10 text

https://www.npmjs.com/package/ja-greetings

Slide 11

Slide 11 text

https://www.npmjs.com/package/ja-greetings Please download

Slide 12

Slide 12 text

https://www.npmjs.com/package/cmd-ranking

Slide 13

Slide 13 text

https://www.npmjs.com/package/cmd-ranking Please download

Slide 14

Slide 14 text

Why ?

Slide 15

Slide 15 text

1. JavaScript 2. Studying asynchronous processing ✎ 3. Easier than I thought 4. There are lots of knowledge Because…

Slide 16

Slide 16 text

Why ?

Slide 17

Slide 17 text

1. High affinity with javascript 2. Studying OSS ✎ Because…

Slide 18

Slide 18 text

Procedure until release to npm

Slide 19

Slide 19 text

1. Create account on npm site 2. Develop library 3. Write setting items necessary for package.json 4. Login npm on your terminal 5. execute “npm publish” ToDo

Slide 20

Slide 20 text

package.json (excerpt)

Slide 21

Slide 21 text

package.json (excerpt)

Slide 22

Slide 22 text

What do I need for OSS? (tips)

Slide 23

Slide 23 text

• Enrich README • Enhance help • Prepare a shortcut command • Put some badges on README Tips

Slide 24

Slide 24 text

README contents

Slide 25

Slide 25 text

-h, —help

Slide 26

Slide 26 text

shortcut shortcut command

Slide 27

Slide 27 text

shortcut The substance is this

Slide 28

Slide 28 text

Plz show this site → https://shields.io/ BTW, We can also make our own badge ↓ For badges