Recommended
More Related Content
Similar to How To Open Source
Similar to How To Open Source (20)
More from Lucas Lira Gomes
More from Lucas Lira Gomes (7)
Recently uploaded
Recently uploaded (20)
How To Open Source
- 1. How To Open Source Lucas Gomes <@x8lucas8x>
- 2. Software Engineer Passionate Hacker ArchLinux Zealot FOSS Enthusiast I’m fond of doing things that last and all that jazz. Lucas Lira Gomes 2 contact@x8lucas8x.com linkedin.com/in/x8lucas8x facebook.com/x8lucas8x youtube.com/X80lucas08X twitter.com/x8lucas8x x8lucas8x.com github.com/x8lucas8x
- 3. Agenda ● The basics ○ Ethos ○ Licensing ○ File Structure ○ Publishing ● The odyssey ○ Revision Control ○ Versioning 3 ○ Documenting ○ Testing ● Get involved ○ First steps ○ Being mentored ○ More than code ● References ● Q & A
- 4. The basics 4
- 5. Ethos - Communities ● Communities ○ Horizontal ○ Hacker culture ■ Challenges ■ Meritocracy ○ Decision Making ■ BDFL ■ Committee 5
- 6. Ethos - Ideology “Given enough eyeballs, all bugs are shallow.” 6 “Free as in free speech, not as in free beer.”
- 7. Licensing ● Why? ● Types ● Copyleft ● Major Players ● Compatibility ● Popularity 7
- 8. Licensing - Why? ● Define your duties/rights ○ Can ○ Cannot ○ Must ● “Fixed work” == Copyright by default ○ Berne Convention (1886) 8
- 9. Licensing - Types ● Proprietary ● Permissive ● Copyleft ○ Weak ○ Strong 9
- 11. Licensing - Copyleft 11 Missing the Point
- 12. Licensing - Copyleft ● Pioneered by RMS ● Safeguard for freedom ● “Viral” effect ○ “Share and share alike” ○ Form of “quid pro quo” 12
- 13. Licensing - Major Players 13
- 14. Licensing - FSF 14 ● GPL ● LGPL ● AGPL ● ...
- 15. Licensing - GPL 15 ● Strong Copyleft ● Main target ○ Applications ● Version 3 ○ Avoids tivolisation ○ Avoids patent treachery
- 16. Licensing - LGPL 16 ● Weak Copyleft ● Main target ○ Libraries ● Version 3 ○ Avoids tivolisation ○ Avoids patent treachery
- 17. Licensing - AGPL 17 ● Strong Copyleft ● More restrictive ○ “Network aware” ● Main target ○ Service Providers ● Version 3 ○ Avoids tivolisation ○ Avoids patent treachery
- 18. Licensing - OSI 18 ● MIT License ● BSD 3-Clause / New License ● BSD 2-Clause / Simplified License ● Apache 2 License ● ...
- 19. Licensing - MIT 19 ● Permissive License ● Almost Public Domain ○ No Liability ○ Allows sublicensing ○ Disclosing source is optional
- 20. Licensing - BSD 3 20 ● Permissive License ● Similar to MIT/X11 ○ But prohibits using copyright holder in promotion
- 21. Licensing - BSD 2 21 ● Permissive License ● Similar to MIT/X11
- 22. Licensing - Apache 2 22 ● Permissive license ● Avoids patent treachery
- 25. Licensing - Need help? 1. http://tldrlegal.com/ 2. http://choosealicense.com/ 3. http://gnu.org/licenses/license-recommendations.html 25
- 26. Licensing - How to apply? ● Go to the root of your source ○ Create a LICENSE file ○ Paste your license ● FSF recommends ○ Add a boilerplate notice to files 26
- 27. File Structure /project /src /docs /tests /scripts /examples LICENSE README AUTHORS Lots of DotFiles 27
- 28. File Structure /project /src /docs /tests /scripts /examples LICENSE README AUTHORS Lots of DotFiles 28
- 29. Publishing ● Out in the open ○ GitHub ○ GitLab ○ BitBucket ○ Codeplex ○ Launchpad ○ Community owned 29 ● For new releases ○ Tarball ○ Changelog
- 30. The odyssey 30
- 31. Revision Control ● Helps to ○ Implement changes ○ Delegate source code ops ○ Track history of your project ● Beware of ○ Centralised CVS 31
- 32. Revision Control ● BitKeeper was a watershed ○ First distributed VCS ○ Proprietary ■ Source of controversies ○ No cost for FLOSS communities ■ Given no similar product was built 32
- 33. Revision Control ● Timeline ○ 2002 - GNU/Linux adoption ○ 2005 - BitMover dropped GNU/Linux support ● Community response ○ GIT ○ Mercurial ○ Bazaar 33
- 34. Revision Control - Wrap-Up ● Favour a distributed one ○ Die SVN m/ m/ 34
- 35. Versioning - Intro ● Helps to ○ Dependency management ● Beware of ○ Dependency hell ■ Version lock ■ Version promiscuity 35
- 36. Versioning - Use ● Semantic Versioning ○ Proposed by Tom Preston-Werner ○ Not revolutionary ■ Based on widespread common practices 36
- 39. Versioning - SemVer ● For new projects ○ Start with 0.1.0 ○ If backwards compatibility worries you ■ Release 1.0.0 (i.e. production ready) ● More on ○ http://semver.org/ 39
- 40. Versioning - Wrap-up ● Formalisation is needed ○ Backwards compatibility must be clear 40
- 41. Documenting - Intro ● Helps to ○ Facilitate adoption ○ Expose code complexity/inconsistencies ● Beware of ○ Poor documentation ■ Worse than none ■ Undermines trust 41
- 42. Documenting - Use ● Battle-tested frameworks ○ Choose your flavour ○ Inline support ○ Markdown / reStructuredText 42
- 43. Documenting - Use ● Automate when possible ○ https://readme.io/ ○ https://readthedocs.org/ ● Inspire yourself ○ http://doc.qt.io/ 43
- 44. Documenting - Wrap-up ● Self-document your code ○ Make your job easier ○ Not a replacement 44
- 45. Testing - Intro ● Helps to ○ Reveal code smells ○ Prevent regressions ■ Refactoring shouldn’t worry you 45
- 46. Testing - Intro ● Beware of ○ Natural tests killers ■ Global state ■ Implicit Initialisation ○ Bad practices ■ Long tests ■ Not informative ■ Success depends on order 46
- 47. Testing - Use ● Battle-tested Frameworks ○ Choose your flavour ● Dependency injection is your friend ● Automate when possible ○ Git hooks ○ Continuous integration 47
- 48. Testing - Wrap-up ● Tests aren’t flawless ○ As good as your understanding ● Not your objective ○ 100% coverage 48
- 49. Get Involved 49
- 50. Get Involved - First Steps ● Find a project ○ Do you use it? ○ Are you OK with its license? ○ Is its community active? 50
- 51. Get Involved - First Steps ● Before asking, try yourself ○ Nobody likes to babysit people ● Frontlines ○ IRC ○ Mailing lists ○ Forums 51
- 52. Get Involved - First Steps ● When asking ○ Be polite ○ Not personal ● Mix in ○ Help others ○ Learn from others ○ Understand their ethos 52
- 53. Get Involved - First Steps ● Give it back ○ Find an easy bug ■ TODO ■ BugTracker ○ Follow standards ● If no response ○ Send a reminder after some time 53
- 54. More than code ● Designers ● SysAdmins ● Translators ● Evangelists ● Bug Squads ● Content Writers 54
- 56. Google Summer of Code ● “Flip bits, not burguers” ○ For 3 months ■ US$ 5000 ■ US$ 500 ● In 2015 ○ 137 Organisations ○ 1051 Students 56
- 57. How to get accepted ● [HOW TO] Write a GSoC Proposal ● GSoC: Why, what and.. the how ● Cracking Google Summer Of Code ● How Not To Apply For Summer Of Code ● HOWTO: Write a Summer of Code application ● How to write a kick-ass proposal for Google Summer of Code 57
- 58. References 1. Raymond, Eric. "The cathedral and the bazaar." Knowledge, Technology & Policy 12.3 (1999): 23-49. 2. Raymond, Eric S. "Homesteading the noosphere." First Monday 3.10 (1998). 3. Raymond, Eric S. "The magic cauldron." (1999). 4. http://www.jeffknupp.com/blog/2013/08/16/open-sourcin g-a-python-project-the-right-way/ 58
- 59. How To Open Source Lucas Gomes <@x8lucas8x>