Skip to content

Latest commit

 

History

History
101 lines (72 loc) · 8.17 KB

README.md

File metadata and controls

101 lines (72 loc) · 8.17 KB

Bringing a Call for Code project to the Linux Foundation

License Slack

This repository contains details on what is needed for Call for Code projects to join the Linux Foundation under the Call for Code umbrella.

Why host your project at the Linux Foundation

  • The LF provides a neutral home for the open source code that can power many business models on top

  • The project legal structure provides a way for many participants to improve the underlying technology

  • The LF has many avenues to access developers, funding, mentorship, events, and marketing

  • Successful projects depend on an ecosystem to develop solutions that the market will adopt. Adoption drives sustainability.

  • Learn more in this detailed presentation.

    The innovation cycle at the Linux Foundation

Beginning your journey with the Linux Foundation

Once we have worked out the intended mission and scope of the sponsored project, we work to build out a formation group to draft the governance documents and finalize the project structure as a community.

Towards the end of the formation process we often convene a marketing team, and the LF will prepare the launch press release with input and feedback from the marketing team.

In addition to increased efficiency, working in formation teams allows for the community to begin collaborating before the project even formally launches.

Preparing to open source a project with the Linux Foundation

Ecosystem and documents

  • Prepare mission and scope statement for the Linux Foundation Technical Charter
  • Analyze code for license consistency with Apache 2 LICENSE or other as needed
  • Assess ecosystem of launch partners who would be part of the announcement (Ideally at least 1)
  • Choose new name or hand over existing names and trademarks
  • Identify marketing, content, communications or other needs for the project (including from IBM)
  • Prep content for developers to take part in the project on day one
  • Choose Technical Steering Committee members
  • Prepare Slack channel or workspace for contributors
  • Evaluate LFX options for marketing, community, funding

GitHub and source code updates

  • Add the Apache 2 LICENSE to your GitHub repository and include the specific copyright header to your source code files using the relevant comment syntax for the programming language. Add the license file as is, then use the current year and list the names of your team members in your individual source files.
  • Look at improving your documentation so that first time visitors clearly see the problem you are solving and how they can understand the solution in your README.md. Also consider enabling alternative language translations.
  • Look at carefully documenting installation/duplication steps so that new developers can explore the technology on their own systems in order to contribute back fixes. This will also help you identify any potential dependency issues you might have on clean installations.
  • Add a basic CONTRIBUTING.md that describes how others can start to collaborating with you. The Linux Foundation has a few sample files you can use for inspiration. The way you choose to accept fixes is up to you though.
  • Strongly consider adding the Developer Certificate of Origin bot to your repositories. This provides assurance that anyone who contributes to your repository has the rights to the code they want to provide.
  • Consider configuring GitHub pages to create a basic description and FAQ site, like gql.foundation

Examples

Project OWL

Prometeo

Build Change

Liquid Prep

Grillo

Agrolly

Resources