Slides for an introductory talk on opensource delivered at h4ckademy, Google Campus Madrid, on august 2015
How to manage anopen source projectJuanjo Bazán @xuanxuh4ckademy
View Slide
Prerequisites• You know how to use git• You know how to use github
Am I ready?
License
LicenseAdd a License.txt file
Which license?MITApacheGPLAfferoBeerware
http://ChooseALicense.com
But my code is notready!
Yes it is!
Everything is Broken
Release early
Let others spreadyour word
Let others fixyour code
Let others improveyour code
What is the goal ofopensource my code?
Increase use of the codeWhat is the goal ofopensource my code?
Increase use of the codeBenefit from collaborationWhat is the goal ofopensource my code?
More use?How?
More use?README file
README file• Present the project• Step-by-step Install Instructions• Status of the Project (build info/date/...)• Basic use case/examples• Contact info
More collaboration?How?
More collaboration?CONTRIBUTING file
CONTRIBUTING file• How to report bugs• How to suggest improvements / newfeatures• How to contribute code• Style guides
Nurture a community• Be polite with rejections• Explain your whys/why-nots• Answer as much/fast as you can• Delegate
A commoncollaboration model
Github Issues
Use labels wisely
Topic Branches+Pull Requests
Delegate
MakeCommunicationeasy
SlackSlacklineIRCGitter
Take care of yourshowcase
Code of conduct
More tools• Trello• GH Wikis• Custom website / GH pages
An open source projectis a community ofPEOPLE
Managing code iseasyManaging people ishard
LicenseReadme fileContributing fileTimeLove
Good luck!
Thanks!
Questions?@xuanxuPicture Credits:https://www.flickr.com/photos/dhilowitz/16594181774https://www.flickr.com/photos/kevharb/4913784320/https://www.flickr.com/photos/ksayer/5614813544/