Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
122 lines (71 sloc) 14.6 KB

Starting Your OASIS Open Project

Whether you’re an established group with a fully scoped Project or a few people with a great idea, OASIS can provide the resources you need to achieve international recognition and widespread adoption.

This guide is for projects that are moving into OASIS Open Projects from:

  1. an existing enterprise open source effort,
  2. an existing community open source effort, or
  3. a technical committee or working group open source effort.

There are no subject-matter limitations at OASIS. Projects decide on the technical agenda they wish to pursue. OASIS supports efforts ranging from cybersecurity, cloud computing, IoT, cryptography, privacy, law, emergency management, augmented reality, static analysis, and many other areas of interest to our community. People involved in IT, telecommunications, healthcare, utilities, financial services, academia, government, and other industries all collaborate on work at OASIS.

High-level Overview

Becoming an OASIS Open Project involves just a few, but important steps:

  1. Drafting a Charter
  2. Identifying Project Sponsors
  3. Selecting a License
  4. Submitting Your Charter
  5. Identifying Roles
  6. Selecting Collaboration Tools
  7. Launching Your Project

If you have a question or need help at any step in the process, please don't hesitate to contact OASIS. We're here to help you navigate the oftentimes complex world of IPR, organizational design, and community development in order to set your project up success. Let's get started!

Draft A Charter

The first step to starting your Open Project is to draft a charter, which describes the goals and scope of your Project and provides relevant information for attracting broader participation and feedback. Drafting the charter and collaborating on it with your peers helps focus your attention on what is most impactful and important to the project, and helps everyone stay on the same page throughout the process.

Begin by reviewing the Open Project Charter Template. We recommend openly collaborating on the charter with others via shared editing tools like Google Docs or via an issue on GitHub. If you need help setting this up, let us know.

The template requires eight sections of content:

  1. Project Name - the project's unique identifier.
  2. Abstract - a high-level, concise (80 words or fewer) description of the project, which helps OASIS & others communicate about the project.
  3. Purpose and Scope - the specific problems your project addresses, described in a way that a person moderately versed in the subject area will understand. After adoption, this section can (and should!) be updated throughout your project's lifecycle.
  4. Business Benefits - in this section, you'll get specific about key stakeholders (organizations, vertical industries, professional communities, etc) and how they benefit from or add value the project. This section helps you and OASIS make the case for being part of the work to potential sponsors and participants.
  5. Relationship to Other Projects - this section helps people understand where the project fits in the current landscape. OASIS staff may also use this information to connect your project with other projects and stakeholders in the space.
  6. Repositories and Licenses - the list of GitHub organizations, repository names, urls, and current applicable licenses if any for the initial repositories you expect to become an OASIS Open Project. If you plan to create initialize a new GitHub organization or change licenses, you should note that here.
  7. Initial Contributions from Existing Work - If you plan to contribute existing specifications, repositories, or documentation to your project, provide those details and links in this section. This is particularly important for projects that may want to produce OASIS standards.
  8. Project Leadership - provide names, email addresses, and organizational affiliations (if any) for current maintainers and sponsors, as well as people interested in sponsoring and contributing to the project. Be sure you have everyone’s consent to list their names in the charter.

It’s a good idea to socialize your draft charter, solicit feedback, and build a core of support before the project is announced as an OASIS Open Project. Developers and organizations alike are attracted to projects that demonstrate momentum and commitment from a diverse community of partners and competitors, so spend as much time as you need to draft a clear, compelling charter. OASIS staff are happy to review and offer editorial suggestions at any point.

The final version of your charter will need to be submitted in English, but feel free to work in whatever language is comfortable for your community to get started. OASIS can help with translations when you're ready to submit your final draft.

Identifying Project Sponsors

One of the advantages of starting your Open Project at OASIS is the opportunity recruit sponsors (and contributors) from our international community. Whether you start your project with a large, robust community or a few people, OASIS staff will work with you to recruit supporters before and after your project is launched.

Identifying organizations that will sponsor your project is an important step. Project sponsors pay Annual project sponsorship dues that cover the basic support services provided by OASIS. These dues vary based on the organization's size and level of investment in the project. Project Sponsors may appoint one organizational representative to serve on the Project Governing Board (PGB).

Before your project can launch as an OASIS Open Project, it must meet a minimum threshold in annual sponsorship commitments. If you don’t have the minimum sponsorship for your project — or if you’d like to have more stakeholders on board before launch — OASIS staff can help find sponsors for your project from the OASIS member base and beyond.

For each sponsoring organization, provide the name and email address of the representative who will serve on the PGB (the representative may change at any point). You'll also want to identify one person from your soon-to-be PGB who will serve as the primary point of contact for your project prior to launch (the PGB will elect new chairpersons after launch).

You can also provide names, email addresses, and organizational affiliations (if any) for other people interested in contributing to the project. Support from people who are recognized as subject experts or who are affiliated with stakeholder organizations adds credibility to your project and encourages more participation.

OASIS will use this information to kick off sponsorship conversations and purchasing processes with the appropriate organizational stakeholders to secure funding. This process can take time, so it's a good idea to connect with us early and often about potential project sponsors.

Selecting a License

When you fill out your draft charter, you'll provide the names and descriptions for any initial repositories you expect to use for developing project assets and specify your current or preferred license for each repository. Each OASIS Open Project Repository is governed by the open source license selected by the Project Governing Board.

Licenses offer different patent guarantees, reuse rights, and requirements that implementers will need to comply with. Not sure which license to choose? OASIS has decades of experience in IPR policy, and can offer assistance to help you determine what’s right for your project. You can see the current list of supported licenses here.

Contributor License Agreements (CLAs) bind project contributors to the license, ensuring that the contribution is available and implementable under clear legal terms. OASIS Open Project CLAs feature a special Specification Non-Assertion Covenant that assures work produced can be advanced to Project Specification or OASIS Standard status without patent issues or ambiguities.

Participants do not need to sign CLAs in order to review and comment on technical work, file bug reports, and make other non-substantive change requests to Open Project work products. People who wish to make substantive contributions to OASIS Open Projects are required to complete and submit an Individual Contributor License Agreement (I-CLA). If a person’s contributions represent intellectual property owned by a company, organization, or other corporate entity (i.e., contributions made as a designated employee or representative of the entity), then the corporate entity should also complete and submit an Entity Contributor License Agreement (E-CLA). E-CLAs must be signed by all organizations with representatives on Project Governing Boards.

Once your license(s) have been selected, OASIS staff will work with you to set up the CLA collection and auditing tool.

Submitting Your Charter

Let OASIS know via email as soon as you are ready to submit the final draft of your charter. The Open Projects Administrator will review your charter for completeness and ensure it meets all requirements. If something’s missing, we’ll help you address it.

Submitting your final charter kicks off our internal pre-launch checklist process, wherein we confirm all the tools and required paperwork are in place to "go live" with your Open Project!

Identifying Roles

There are many ways to participate in an Open Project, formally and informally. Anyone can view the Project’s activity, assets, and repository forks, and download copies of repositories. Participants (anyone with a GitHub account) can submit comments, report bugs, open issues, and request new features. Contributors are people who have signed the project's CLA and thus can submit contributions by creating pull requests.

Maintainers maintain the codebase, review and approve pull requests, build binary packages for distribution, and generally act as the editors and managers of the project's repositories. As such, commitment and expertise are key criteria for selecting Maintainers. Maintainers see to it that the technical consensus of the PGB and the community guide the project work. An Open Project must have at least one Maintainer; ideally there should be a maintainer team overseeing all of the project's repositories.

The Project Governing Board (PGB) develops and manages the overall product strategy of the Project, votes on major releases, and decides if/when to submit work for standards approval. They are responsible for ensuring that there is a designated Maintainer for project repos. They are also responsible for making sure important updates and messages about the project are sent to the community in a timely fashion, via mailing lists and social channels. A PGB may choose to form additional committees and/or other groups related to project efforts, such as marketing, events, and so forth, to delegate these tasks.

The PGB will select one or two of its members to serve as Chairperson(s). The role of the Chair is to manage the PGB’s logistics, agenda, and decision-making. The Chair(s) help the PGB reach consensus on topics, coordinate and lead meetings of the PGB or the broader community and, when needed, work with OASIS staff on related events, assist the maintainer(s) when necessary, and act as the project's main point of contact with OASIS staff. PGB activities are suspended while the Chair role is vacant.

The Technical Steering Committee (TSC) is chartered by the PGB to direct the day-to-day technical activities of the project. The TSC may be comprised of Maintainers, Contributors, and Project Sponsors as best suits the project - the responsibilities, appointment criteria, and size of the TSC is determined by the PGB in concert with the needs and preferences of its community.

As you prepare to launch your Open Project, it is important to identify the people who will be filling these important roles and help them understand and accept their responsibilities. Projects may chose to adjust these roles or add new ones, but the structure outlined in this section describes the minimum governance model required of all Open Projects.

Selecting Collaboration Tools

Chances are, your project already relies on a number of the same software collaboration tools we recommend for OASIS Open Projects. OASIS requires Open Projects to have publicly accessible tools for collaboration and development (see our visibility policy for more information).

If your project doesn't yet have tools for things like integrated issue management, project boards, version control, release management, or Wiki pages, OASIS can help you set them up. Additionally, OASIS will support publicly archived email discussion lists and coordination with maintainers of any custom web sites or community portal web sites associated with an Open Project.

OASIS Open Projects are expected to use git and GitHub for most collaborative development tasks. Projects are also strongly encouraged to have a website and use social media channels to socialize their work. OASIS can help set these tools up, or even maintain them, if needed.

Your project's PGB may elect to adopt additional collaboration or workflow tools after the project launches. Any tools selected for official use by the project must be cleared with OASIS - because Open Projects are expected to conduct business in public view, we want to ensure that access and archivability are prioritized.

As part of the internal pre-launch checklist process, we will review your project's existing toolset and determine if there are any gaps. Subject to resourcing and policy constraints, OASIS may provide additional online resources for Open Projects that may be needed in the future.

Launching Your Project

OASIS will officially launch your project as soon as possible after your final charter has been submitted and reviewed, and the pre-flight checklist has been complete.

OASIS will announce the project via press release, and issue an invitation to participate via OASIS websites, mailing lists, and social media channels. We will also work with Project Sponsors and community stakeholders to help them amplify the launch message to ensure maximum reach.

With your project launched, it's time to get busy collaborating! Check out these additional guides for more help, or contact OASIS to take your next step as an Open Project.

You can’t perform that action at this time.