How to manage an open source project

How to manage an open source project

Slides for an introductory talk on opensource delivered at h4ckademy, Google Campus Madrid, on august 2015

6b4aa22626f1183813b502e2d1f4ea2a?s=128

Juanjo Bazán

August 12, 2015
Tweet

Transcript

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

    h4ckademy
  2. Prerequisites • You know how to use git • You

    know how to use github
  3. Am I ready?

  4. None
  5. License

  6. License Add a License.txt file

  7. Which license? MIT Apache GPL Affero Beerware

  8. http://ChooseALicense.com

  9. But my code is not ready!

  10. Yes it is!

  11. Everything is Broken

  12. Release early

  13. Let others spread your word

  14. Let others fix your code

  15. Let others fix your code

  16. Let others improve your code

  17. What is the goal of opensource my code?

  18. Increase use of the code What is the goal of

    opensource my code?
  19. Increase use of the code Benefit from collaboration What is

    the goal of opensource my code?
  20. More use? How?

  21. More use? README file

  22. README file • Present the project • Step-by-step Install Instructions

    • Status of the Project (build info/date/...) • Basic use case/examples • Contact info
  23. More collaboration? How?

  24. More collaboration? CONTRIBUTING file

  25. CONTRIBUTING file • How to report bugs • How to

    suggest improvements / new features • How to contribute code • Style guides
  26. Nurture a community • Be polite with rejections • Explain

    your whys/why-nots • Answer as much/fast as you can • Delegate
  27. A common collaboration model

  28. Github Issues

  29. None
  30. None
  31. None
  32. Use labels wisely

  33. None
  34. None
  35. None
  36. None
  37. Topic Branches + Pull Requests

  38. None
  39. Delegate

  40. None
  41. None
  42. Make Communication easy

  43. Slack Slackline IRC Gitter

  44. Take care of your showcase

  45. Code of conduct

  46. None
  47. None
  48. None
  49. More tools • Trello • GH Wikis • Custom website

    / GH pages
  50. An open source project is a community of PEOPLE

  51. Managing code is easy Managing people is hard

  52. License Readme file Contributing file Time Love

  53. Good luck!

  54. Thanks!

  55. 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/