How to manage an open source project

Slide 1

Slide 1 text

How to manage an open source project Juanjo Bazán @xuanxu h4ckademy

Slide 2

Slide 2 text

Prerequisites • You know how to use git • You know how to use github

Slide 3

Slide 3 text

Am I ready?

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

License

Slide 6

Slide 6 text

License Add a License.txt ﬁle

Slide 7

Slide 7 text

Which license? MIT Apache GPL Affero Beerware

Slide 8

Slide 8 text

http://ChooseALicense.com

Slide 9

Slide 9 text

But my code is not ready!

Slide 10

Slide 10 text

Yes it is!

Slide 11

Slide 11 text

Everything is Broken

Slide 12

Slide 12 text

Release early

Slide 13

Slide 13 text

Let others spread your word

Slide 14

Slide 14 text

Let others ﬁx your code

Slide 15

Slide 15 text

Let others ﬁx your code

Slide 16

Slide 16 text

Let others improve your code

Slide 17

Slide 17 text

What is the goal of opensource my code?

Slide 18

Slide 18 text

Increase use of the code What is the goal of opensource my code?

Slide 19

Slide 19 text

Increase use of the code Beneﬁt from collaboration What is the goal of opensource my code?

Slide 20

Slide 20 text

More use? How?

Slide 21

Slide 21 text

More use? README ﬁle

Slide 22

Slide 22 text

README ﬁle • Present the project • Step-by-step Install Instructions • Status of the Project (build info/date/...) • Basic use case/examples • Contact info

Slide 23

Slide 23 text

More collaboration? How?

Slide 24

Slide 24 text

More collaboration? CONTRIBUTING ﬁle

Slide 25

Slide 25 text

CONTRIBUTING ﬁle • How to report bugs • How to suggest improvements / new features • How to contribute code • Style guides

Slide 26

Slide 26 text

Nurture a community • Be polite with rejections • Explain your whys/why-nots • Answer as much/fast as you can • Delegate

Slide 27

Slide 27 text

A common collaboration model

Slide 28

Slide 28 text

Github Issues

Slide 29

Slide 29 text

No content

Slide 30

Slide 30 text

No content

Slide 31

Slide 31 text

No content

Slide 32

Slide 32 text

Use labels wisely

Slide 33

Slide 33 text

No content

Slide 34

Slide 34 text

No content

Slide 35

Slide 35 text

No content

Slide 36

Slide 36 text

No content

Slide 37

Slide 37 text

Topic Branches + Pull Requests

Slide 38

Slide 38 text

No content

Slide 39

Slide 39 text

Delegate

Slide 40

Slide 40 text

No content

Slide 41

Slide 41 text

No content

Slide 42

Slide 42 text

Make Communication easy

Slide 43

Slide 43 text

Slack Slackline IRC Gitter

Slide 44

Slide 44 text

Take care of your showcase

Slide 45

Slide 45 text

Code of conduct

Slide 46

Slide 46 text

No content

Slide 47

Slide 47 text

No content

Slide 48

Slide 48 text

No content

Slide 49

Slide 49 text

More tools • Trello • GH Wikis • Custom website / GH pages

Slide 50

Slide 50 text

An open source project is a community of PEOPLE

Slide 51

Slide 51 text

Managing code is easy Managing people is hard

Slide 52

Slide 52 text

License Readme ﬁle Contributing ﬁle Time Love

Slide 53

Slide 53 text

Good luck!

Slide 54

Slide 54 text

Thanks!

Slide 55

Slide 55 text

Questions? @xuanxu Picture Credits: https://www.flickr.com/photos/dhilowitz/16594181774 https://www.flickr.com/photos/kevharb/4913784320/ https://www.flickr.com/photos/ksayer/5614813544/