How to manage an open source project Juanjo Bazán @xuanxu h 4 ckademy
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
How to manage an open source project
Juanjo Bazán @xuanxu
h4ckademy
Prerequisites
• You know how to use git
• You know how to use github
Am I ready?
License
License
Add a License.txt file
Which license?
MITApache
GPLAffero
Beerware
But my code is not ready!
Yes it is!
Everything is Broken
Release early
Let others spread your word
Let others fix your code
Let others fix your code
Let others improve your code
What is the goal of opensource my code?
Increase use of the code
What is the goal of opensource my code?
Increase use of the code
Benefit from collaboration
What is the goal of opensource 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 / new features
• 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 common collaboration model
Github Issues
Use labels wisely
Topic Branches +
Pull Requests
Delegate
Make Communication
easy
Slack Slackline
IRC Gitter
Take care of your showcase
Code of conduct
More tools
• Trello
• GH Wikis
• Custom website / GH pages
An open source project is a community of
PEOPLE
Managing code is easy
Managing people is hard
License Readme file
Contributing file Time Love
Good luck!
Thanks!
Questions?
@xuanxuPicture Credits:https://www.flickr.com/photos/dhilowitz/16594181774 https://www.flickr.com/photos/kevharb/4913784320/https://www.flickr.com/photos/ksayer/5614813544/
Related Documents
