OTB Graduation Checklist

Incubation Checklist

Open

The project has demonstrated that it has an open, active and healthy user and developer community:

1. Open: projects are expected to function in an open and public manner and include:
   • Open source license(s),
     • Apache License 2.0
   • Open communication channels,
     • The project currently provides support through a mailing list, managed using Google Groups (otb-users and otb-developers).
   • Open decision making process,
     • A Project Steering Committee has been formed and it is now used to make decisions for the software project. (See: http://wiki.orfeo-toolbox.org/index.php/Project_Steering_Committee and http://wiki.orfeo-toolbox.org/index.php/Summary_of_PSC_Decisions)
     • Update: (2015-07-24) A Project Steering Committee has been formed. Management decisions are now made in a standard way. Details on the Project Steering Committee can be found at http://wiki.orfeo-toolbox.org/index.php/Project_Steering_Committee.
2. Active and healthy community:
   • The project should have a community of developers and users who actively collaborate and support each other in a healthy way.
     
     • release process? LINK https://wiki.orfeo-toolbox.org/index.php/Release_planning
     • bugs and feature requests? LINK https://bugs.orfeo-toolbox.org/my_view_page.php
     • devel communication? LINK https://www.orfeo-toolbox.org/SoftwareGuide/SoftwareGuidech1.html#x10-140001.4
   • Long term viability of the project is demonstrated by showing participation and direction from multiple developers, who come from multiple organizations.
     
     • Contributions from several organizations shown in the PSC page including CNES.fr , IRSTEA , CS-SI.fr , cesbio.eu

Copyright and License

We need to ensure that the project owns or otherwise has obtained the ability to release the project code by completing the following steps:

1. All project source code is available under an Open Source license.
   • https://git.orfeo-toolbox.org/otb.git/blob/HEAD:/LICENSE
2. Project documentation is available under an open license, such as Creative Commons.
   • Website and Cookbook are licensed under a Creative Commons Attribution-ShareAlike 4.0 International license (CC-BY-SA) (see related RFC for the Cookbook adopted in June 2017: https://wiki.orfeo-toolbox.org/index.php/Request_for_Changes-94:_CookBook_licensed_under_cc-by-sa)
3. The project code, documentation and data has been adequately vetted to assure it is all properly licensed, and a copyright notice included, as per a Provenance Review.
   • https://wiki.osgeo.org/wiki/OTB_Code_Provenance_Review
4. The project maintains a list of all copyright holders identified in the Provenance Review Document.
   • Following Apache copyright notice recommendations. The list of all copyright holders identified is maintain in the NOTICE file in the source tree: [1]
5. All code contributors have agreed to abide by the project's license policy, and this agreement has been documented and archived.
   • List of all contributors is available in the OTB Software Guide. Moreover to accept your contribution, developers need to sign and email to cla@orfeo-toolbox.org an "Individual Contributor Licensing Agreement" (ICLA) form and a "Corporate Contributor Licensing Agreement" (CCLA) form if you are contributing on behalf of your company or another entity which retains copyright for your contribution. The ICLA and CCLA are based on ICLA provided by the Apache Software foundation and are archived on the OTB server.

Processes

1. The project has code under configuration management.
   Eg, subversion, git.
   • Git https://git.orfeo-toolbox.org - There is also a mirror on GitHub: https://github.com/orfeotoolbox/OTB
2. The project uses an issue tracker and keeps the status of the issue tracker up to date.
   • https://bugs.orfeo-toolbox.org/my_view_page.php
3. The project has documented its management processes.
   This is typically done within a Developers Guide or Project Management Plan.
   • https://www.orfeo-toolbox.org/community/
4. The project has a suitable open governance policy ensuring decisions are made, documented and adhered to in a public manner.
   This typically means a Project Management Committee has been established with a process for adding new members. A robust Project Management Committee will typically draw upon developers, users and key stakeholders from multiple organizations as there will be a greater variety of technical visions and the project is more resilient to a sponsor leaving.
   • Details on the Project Steering Committee can be found at http://wiki.orfeo-toolbox.org/index.php/Project_Steering_Committee and also https://www.orfeo-toolbox.org/community/
5. The project uses public communication channels for decision making to maintain transparency.
   E.g. archived email list(s), archived IRC channel(s), public issue tracker.
   • New features have to been describe in a RFC and discuss and vote publicly on the mailing list. The list of all RFCs is available on the OTB wiki (https://wiki.orfeo-toolbox.org/index.php/Requests_for_Changes). Moreover there is also a public JIRA system available to follow day by day developments linked via https://wiki.orfeo-toolbox.org/index.php/Git

Documentation

1. The project has user documentation:
   • Including sufficient detail to guide a new user through performing the core functionality provided by the application.
     • FAQ English https://www.orfeo-toolbox.org/packages/OTB-FAQ.pdf
2. The project has developer documentation:
   • Including checkout and build instructions.
     • FAQ English https://www.orfeo-toolbox.org/packages/OTB-FAQ.pdf
   • Including commented code, ideally published for developer use.
     Examples: javadocs for Java applications, or Sphinx documentation for Python applications.
     • https://www.orfeo-toolbox.org/packages/OTBSoftwareGuide.pdf and https://www.orfeo-toolbox.org/doxygen/
   • Providing sufficient detail for an experience programmer to contribute patches or a new module in accordance with the project's programming conventions.
     • https://www.orfeo-toolbox.org/SoftwareGuide/SoftwareGuidech32.html#x63-43000032 and https://wiki.orfeo-toolbox.org/index.php/Contributors_guidelines

Release Procedure

In order to maintain a consistent level of quality, the project should follow defined release and testing processes.

1. The project follows a defined release process:
   • The release process is described in the OTB wiki https://wiki.orfeo-toolbox.org/index.php/How_to_Release
   • Which includes execution of the testing process before releasing a stable release.
2. The project follows a documented testing process.
   Ideally, this includes both automated and manual testing
   Ideally this includes documented conformance to set quality goals, such as reporting Percentage Code Coverage of Unit Tests.
   • See OTB Cdash (nightly builds, unit tests and code coverage submissions): https://dash.orfeo-toolbox.org/
3. Release and testing processes provide sufficient detail for an experienced programmer to follow.
   • See "help for release actions" page on th wiki which provides some guidelines to follow: https://wiki.orfeo-toolbox.org/index.php/Help_for_release_actions

OSGeo Committees and Community

The OSGeo Foundation is made up of a number of committees, projects and local chapters. This section gathers up information these groups have requested from OSGeo projects. These expectations are not mandatory requirements before graduation, but a project should be prepared to address them in order to be considered a good OSGeo citizen.

Board

The OSGeo Board holds ultimate responsibility for all OSGeo activities. The Board requests:

1. A project provide a Project Officer as a contract point:
   • The Project Officer should be listed at: Project Officer
   • This person is established when the incubation committee recommends the project for graduation
   • Your community can change the project officer as needed (just add an agenda item to the next board meeting so they can recognise the change of officer).

Marketing

Access to OSGeo's Marketing_Committee and associated Marketing_Pipeline is one of the key benefits of joining the OSGeo foundation. The Marketing Committee requests:

1. Marketing artefacts have been created about the project in line with the incubation criteria listed in the OSGeo Marketing Committee's Marketing Artefacts. This lists the documentation requirements for OSGeo-Live. Marketing Artefacts include:
   • Application Overview https://live.osgeo.org/en/overview/otb_overview.html
   • Application Quick Start https://live.osgeo.org/en/quickstart/otb_quickstart.html
   • Logo https://live.osgeo.org/_images/logo-otb7.png
   • Graphical Image https://git.orfeo-toolbox.org/otb-documents.git/tree/HEAD:/Artwork
2. Ideally, stable version(s) of executable applications are bundled with appropriate distributions.
   In most cases, this will at least include OSGeo-Live, but may also include DebianGIS, UbuntuGIS, and/or osgeo4w ms4w, etc.)
   • OTB is included is OSGeo-Live , DebianGIS and UbuntuGIS. An old version is also available in osgeo4w, it was not updated for a while due to packaging and dependencies issues.

Projects

Projects do not exist in isolation; and are expected to communicate and collaborate on key issues.

As an example the PostGIS release procedure asks that the release be checked with MapServer, GeoServer and others.

SAC

The System Administration Committee is available to help infrastructure and facilities. Information for this committee is collected as part of the Project Status Template. The following should be set up:

• A http://projectname.osgeo.org domain name.

A project may optionally request SAC help to make use of:

• OSGeo issue tracker
• OSGeo mailing list
• OSGeo svn
• http://downloads.osgeo.org