A Practical Guide to Open Sourcing Proprietary Technology


Published on

Guy Martin from Samsung OSG presents on practical ways to open source formerly proprietary technology.

Published in: Technology
  • Be the first to comment

  • Be the first to like this

No Downloads
Total views
On SlideShare
From Embeds
Number of Embeds
Embeds 0
No embeds

No notes for slide

A Practical Guide to Open Sourcing Proprietary Technology

  1. 1. A Practical Guide to Open Sourcing Proprietary Source Code Guy Martin Senior Strategist – Open Source Group Samsung Research America – Silicon Valley guy.martin@samsung.com Open Source Group – Silicon Valley 1 © 2013 SAMSUNG Electronics Co.
  2. 2. Content High level process Preparations - Business Legal Technical Marketing Project governance Project infrastructure Code review Launch Open Source Group – Silicon Valley 2 © 2013 SAMSUNG Electronics Co.
  3. 3. High Level Process Overview Open Source for the Right Reasons Internal Preparations Legal Preparations Technical Preparations Business Preparations Marketing Preparations Define project governance Set up project infrastructure Final code review Launch and maintain Open Source Group – Silicon Valley 3 © 2013 SAMSUNG Electronics Co.
  4. 4. Preparations: Process Walkthrough Open Source Group – Silicon Valley 4 © 2013 SAMSUNG Electronics Co.
  5. 5. Business Preparations Determine the overall strategy - Defend the “Why are we doing this?” question - Explain the business case/value proposition Find a corporate champion for the project - Ensure there is funding for resources (developers) - Ensure there is funding for open source project infrastructure Open Source Group – Silicon Valley 5 © 2013 SAMSUNG Electronics Co.
  6. 6. Legal Preparations • Legal due diligence: ∙ Patent scrub to identify IP areas in the source code ∙ License/copyright - Decide on the license to release under - Provide license information to embed in source code - Provide standard copyright notice to embed in source code ∙ Decide on a contributor agreement [if starting a new project] ∙ Decide on trademark use, requirements, and process ∙ Run a source code scanning tool on the internal code - Ensure clean bill of materials - Identify all source code originating from outside your company ∙ Other items as necessary Open Source Group – Silicon Valley 6 © 2013 SAMSUNG Electronics Co.
  7. 7. License Selection Considerations • Use a mainstream OSI-approved license (http://opensource.org) • Some factors to consider in choosing a license: - Do you want to relinquish control over how your code is used/distributed? - Do you want to allow your code into non open-source programs? - If somebody uses your code in their program and sells it, do you want some of that money? - Do you want to ensure all future derivatives distribute source code? - Do you want your code to be usable in both open source and proprietary products? - If it’s a library, should non-open source code be allowed to link to it? Open Source Group – Silicon Valley 7 © 2013 SAMSUNG Electronics Co.
  8. 8. Technical Preparations • Clean up the code − Ensure coding style is consistent − Remove internal comments, references to other internal code, etc. − Remove any code not part of open sourcing plan − Remove dependencies on non-public components • Add license and copyright notices ‒ Add license notice in source code files ‒ Add license text as a file in the root directory ‒ Update copyright notices in source code files • Prepare the code for new external users ‒ Provide documentation and use case examples ‒ Ensure it compiles and builds on target platforms ‒ Fully document all APIs Open Source Group – Silicon Valley 8 © 2013 SAMSUNG Electronics Co.
  9. 9. Marketing Preparations Design project logo, color scheme, website, collateral, etc. Formalize branding guidelines (compliance program?) Register social media accounts for the project Register domain names Other items as needed Open Source Group – Silicon Valley 9 © 2013 SAMSUNG Electronics Co.
  10. 10. Define Project Governance Open Source Group – Silicon Valley 10 © 2013 SAMSUNG Electronics Co.
  11. 11. Project Governance • What is governance? - The structure around a project that enables decisions on: ∙ Participation guidelines and requirements ∙ Architectural changes ∙ Nominating maintainers ∙ Final arbiter on disputes ∙ Suspension of participants - Often similar to a board of directors ∙ Typically represents mix of project contributors Image Credit: VisionMobile: CC-BY-SA Open Source Group – Silicon Valley 11 © 2013 SAMSUNG Electronics Co.
  12. 12. Governance Decisions All projects should define and communicate, at minimum: - Processes for submitting code, patches, feature ideas, etc. - Process for technical conflict resolution - Release management process A multi-company project may need more formal governance - Decide on how governance is structured, who can participate, for how long, etc. Example roles of a steering group - Secure funding for the project infrastructure Steer the project to advance its market and technical success Conflict resolution Project level decisions Sets the direction, tone, and vision of the project Approve project roadmap prepared by a technical leadership group Open Source Group – Silicon Valley 12 © 2013 SAMSUNG Electronics Co.
  13. 13. Recommendations for Formal Governance Governing body should represent participating entities Democratic system Clear decision-making process Clear path to resolve disputes Flexibility to adapt to changing project needs Clear means to add new or replace members Open Source Group – Silicon Valley 13 © 2013 SAMSUNG Electronics Co.
  14. 14. Project Maintainer A formal position of leadership within the project Responsibilities include - Setting the criteria for accepted / rejected code Reviewing submitted code / accept and reject based on pre-defined rules Tracking dependency issues Notifying developers of code changes that may affect their packages Managing source code security issues Working closely with team developing the source code Working closely with QA team testing the source code Dealing with reported bugs in a timely manner Preparing binaries – packages of the source code Open Source Group – Silicon Valley 14 © 2013 SAMSUNG Electronics Co.
  15. 15. Setup Project Infrastructure Open Source Group – Silicon Valley 15 © 2013 SAMSUNG Electronics Co.
  16. 16. Setup Project Infrastructure • Essential components - • Nice to have – Wiki Web site Source code repository system Mailing lists IRC Bug and feature tracking • User contributed documentation • How-tos • Works-for-me platform testing results • Team collaboration – Milestone and release tracking – Forums • Support requests, community discussion, and bar talk – Branding • Logo, style guide, graphics, official colors or fonts – Automated build and test system Open Source Group – Silicon Valley 16 © 2013 SAMSUNG Electronics Co.
  17. 17. Project Infrastructure Examples: Front Page What the project does Who is involved Where to find the code Open Source Group – Silicon Valley 17 © 2013 SAMSUNG Electronics Co.
  18. 18. Project Infrastructure Examples: For Developers Open Source Group – Silicon Valley 18 © 2013 SAMSUNG Electronics Co.
  19. 19. Project Infrastructure Examples: Get Involved Open Source Group – Silicon Valley 19 © 2013 SAMSUNG Electronics Co.
  20. 20. Project Infrastructure Examples: Processes Open Source Group – Silicon Valley 20 © 2013 SAMSUNG Electronics Co.
  21. 21. Project Infrastructure Examples: Processes Open Source Group – Silicon Valley 21 © 2013 SAMSUNG Electronics Co.
  22. 22. Project Infrastructure Examples: Sign-off-by Open Source Group – Silicon Valley 22 © 2013 SAMSUNG Electronics Co.
  23. 23. Final Code Review Before Release Open Source Group – Silicon Valley 23 © 2013 SAMSUNG Electronics Co.
  24. 24. Final Code Review Ensures all requirements identified by business, legal, technical, and marketing reviews are completely met Examples: - License, attribution, and copyright texts are all complete and in place Source code scanner reports clean bill of materials Every line of code is licensed appropriately for release Comments are sanitized of casual or unrelated language Source code does not inadvertently reveal internal projects Source code is sufficiently complete that it will build Source code builds using publicly available tools File and function names reflect the project’s name, if it has changed MAINTAINERS file is up to date, if used Open Source Group – Silicon Valley 24 © 2013 SAMSUNG Electronics Co.
  25. 25. Project Launch Open Source Group – Silicon Valley 25 © 2013 SAMSUNG Electronics Co.
  26. 26. Is This Your First? Train your employees and managers - Open source development methods and processes Working with the open source community Your company's open source policies and compliance rules Integrating open source software within your software development model Follow open source practices internally - Context switching between development practices is difficult Encourage community thinking - Welcome help in crafting a more general solution - Leave partisan feelings at the door, you will be working alongside competitors Open Source Group – Silicon Valley 26 © 2013 SAMSUNG Electronics Co.
  27. 27. Prior To Launch Build critical mass before launching - Provide preview to customers and partners so they can begin to work with the code - Lobby for launch-day participants among your existing business partners Ensure that all project infrastructure is running, secure, and scalable Ensure internal developers join and continually monitor IRC channel, mailing lists, etc. Upload the code Open Source Group – Silicon Valley 27 © 2013 SAMSUNG Electronics Co.
  28. 28. Be a Good Open Source Citizen Have conversations and make decisions in the open - Builds goodwill, but also reduces overhead in documenting decisions - Streamlines onboarding process for new participants - Archives ensure continuity if participants change Listen to the community - They know what they are doing, particularly on integration and testing - Encourage generalized implementations that extend what you need, particularly if someone else volunteers Allocate resources as if you will be the only company doing the work - Set goals, and make sure they have resources to get accomplished - This builds momentum until the leveraged development model takes effect Open Source Group – Silicon Valley 28 © 2013 SAMSUNG Electronics Co.
  29. 29. After The Launch Work on building a developer community - Is it easy to find and join as an outsider? - Does the community have the documentation they need, and a means to update it? - Is the process for accepting community code working? Continue to follow open source development model & practices Remain visible Be a good open source citizen Remember: Leadership != Management in Communities Open Source Group – Silicon Valley 29 © 2013 SAMSUNG Electronics Co.
  30. 30. Thank you. Guy Martin Senior Strategist - Open Source Group Samsung Research America – Silicon Valley guy.martin@samsung.com Open Source Group – Silicon Valley 30 © 2013 SAMSUNG Electronics Co.