Difference between revisions of "Opticks Incubation Checklist"

From OSGeo
Jump to navigation Jump to search
(Created page with "= Opticks Incubation Checklist = == Open == The project has demonstrated that it has an open, active and healthy user and developer community: # Open: projects are expected ...")
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
= Opticks Incubation Checklist =
 
= Opticks Incubation Checklist =
 +
Completed sections have been filled out, and sections with work remaining to be done have been marked with <b>TODO</b>.
  
 
== Open ==
 
== Open ==
−
+
 
 
The project has demonstrated that it has an open, active and healthy user and developer community:
 
The project has demonstrated that it has an open, active and healthy user and developer community:
 
# Open: projects are expected to function in an open and public manner and include:
 
# Open: projects are expected to function in an open and public manner and include:
−
#* Open source license(s),
+
#* LGPL v2.1 License
−
#* Open communication channels,
+
#* Open communication via IRC and mailing lists
−
#* Open decision making process,
+
#* Open decision-making via [http://opticks.org/confluence/display/opticks/Opticks+Governance+Policy this] policy
 
# Active and healthy community:
 
# 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. <br/><i>Eg. collaboration on project activities such as testing, release and feature development.</i>
+
#* <b>TODO:</b> The project should have a community of developers and users who actively collaborate and support each other in a healthy way. <br/><i>Eg. collaboration on project activities such as testing, release and feature development.</i>
−
#* Long term viability of the project is demonstrated by showing participation and direction from multiple developers, who come from multiple organisations. <br/> <i> Eg. The project is resilient enough to sustain loss of a developer or supporting organisation, often referred to as having a high [http://en.wikipedia.org/wiki/Bus_factor bus factor]. Decisions are made openly instead of behind closed doors, which empowers all developers to take ownership of the project and facilitates spreading of knowledge between current and future team members.</i>
+
#* <b>TODO:</b> Long term viability of the project is demonstrated by showing participation and direction from multiple developers, who come from multiple organisations. <br/> <i> Eg. The project is resilient enough to sustain loss of a developer or supporting organisation, often referred to as having a high [http://en.wikipedia.org/wiki/Bus_factor bus factor]. Decisions are made openly instead of behind closed doors, which empowers all developers to take ownership of the project and facilitates spreading of knowledge between current and future team members.</i>
  
 
== Copyright and License ==
 
== 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:
 
We need to ensure that the project owns or otherwise has obtained the ability to release the project code by completing the following steps:
−
# All project source code is available under an Open Source license.
+
# LGPL v2.1 license.
−
# Project documentation is available under an open license, such as Creative Commons.
+
# <b>TODO:</b> Project documentation is available under an open license, such as Creative Commons.
−
# 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 [http://www.osgeo.org/incubator/process/codereview.html Provenance Review].
+
# <b>TODO:</b> 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 [http://www.osgeo.org/incubator/process/codereview.html Provenance Review].
−
# The project maintains a list of all copyright holders identified in the Provenance Review Document.  
+
# <b>TODO:</b> The project maintains a list of all copyright holders identified in the Provenance Review Document.  
−
# All code contributors have agreed to abide by the project's license policy, and this agreement has been documented and archived.
+
# <b>TODO:</b> All code contributors have agreed to abide by the project's license policy, and this agreement has been documented and archived.
  
 
== Processes ==
 
== Processes ==
  
−
# The project has code under configuration management. <br/><i>Eg, subversion, git.</i>
+
# Configuration management: svn
−
# The project uses an issue tracker and keeps the status of the issue tracker up to date.
+
# Issue tracker: [https://issues.opticks.org]
−
# The project has documented its management processes. <br/><i>This is typically done within a Developers Guide or Project Management Plan.</i>
+
#* Open decision-making via [http://opticks.org/confluence/display/opticks/Opticks+Governance+Policy this] policy
−
#* The project has a suitable open governance policy ensuring decisions are made, documented and adhered to in a public manner. <br/><i>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 organisations as there will be a greater variety of technical visions and the project is more resilient to a sponsor leaving.</i>
+
#* Open communication via IRC and mailing lists
−
#* The project uses public communication channels for decision making to maintain transparency.<br/><i> E.g. archived email list(s), archived IRC channel(s), public issue tracker.</i>
 
  
 
== Documentation ==
 
== Documentation ==
  
 
# The project has user documentation:
 
# The project has user documentation:
−
#* Including sufficient detail to guide a new user through performing the core functionality provided by the application.
+
#* Included with the binary download and online.
 +
#* [http://opticks.org/confluence/display/opticks/Feature+Tour+-+Your+Data Opticks Feature Tour]
 
# The project has developer documentation:
 
# The project has developer documentation:
−
#* Including checkout and build instructions.
+
#* Including checkout and build instructions in svn repository.
−
#* Including commented code, ideally published for developer use. <br/><i>Examples: javadocs for Java applications, or Sphinx documentation for Python applications.</i>
+
#* Full documentation of the Opticks C++ SDK, published by doxygen.
−
#* Providing sufficient detail for an experience programmer to contribute patches or a new module in accordance with the project's programming conventions.
+
#* Contributing patches to Opticks is explained [http://opticks.org/confluence/display/opticksDev/Welcome+To+Opticks+Development here]
  
 
==Release Procedure==
 
==Release Procedure==
Line 42: Line 43:
 
In order to maintain a consistent level of quality, the project should follow defined release and testing processes.
 
In order to maintain a consistent level of quality, the project should follow defined release and testing processes.
  
−
# The project follows a defined release process:
+
# <b>TODO:</b> The project follows a defined release process:
−
#* Which includes execution of the testing process before releasing a stable release.  
+
#* <b>TODO:</b> Which includes execution of the testing process before releasing a stable release.  
−
# The project follows a documented testing process. <br/><i>Ideally, this includes both automated and manual testing</i><br/><i>Ideally this includes documented conformance to set quality goals, such as reporting Percentage Code Coverage of Unit Tests.</i>
+
# <b>TODO:</b> The project follows a documented testing process. <br/><i>Ideally, this includes both automated and manual testing</i><br/><i>Ideally this includes documented conformance to set quality goals, such as reporting Percentage Code Coverage of Unit Tests.</i>
−
# Release and testing processes provide sufficient detail for an experienced programmer to follow.
+
# <b>TODO:</b> Release and testing processes provide sufficient detail for an experienced programmer to follow.
  
 
= OSGeo Committees and Community =
 
= OSGeo Committees and Community =
Line 55: Line 56:
 
The OSGeo [[Board]] holds ultimate responsibility for all OSGeo activities. The Board requests:
 
The OSGeo [[Board]] holds ultimate responsibility for all OSGeo activities. The Board requests:
  
−
# A project provide a Project Officer as a contract point:
+
# <b>TODO:</b> A project provide a Project Officer as a contract point:
−
#* The Project Officer should be listed at: [[Contacts#Software_Projects|Project Officer]]
+
#* <b>TODO:</b> The Project Officer should be listed at: [[Contacts#Software_Projects|Project Officer]]
−
#* This person is established when the incubation committee recommends the project for graduation
+
#* <b>TODO:</b> 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).
+
#* <b>TODO:</b> 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 ==
 
== Marketing ==
Line 65: Line 66:
  
 
# Marketing artefacts have been created about the project in line with the incubation criteria listed in the OSGeo Marketing Committee's [http://wiki.osgeo.org/wiki/Marketing_Artefacts Marketing Artefacts]. This lists the documentation requirements for [http://live.osgeo.org OSGeo-Live]. Marketing Artefacts include:
 
# Marketing artefacts have been created about the project in line with the incubation criteria listed in the OSGeo Marketing Committee's [http://wiki.osgeo.org/wiki/Marketing_Artefacts Marketing Artefacts]. This lists the documentation requirements for [http://live.osgeo.org OSGeo-Live]. Marketing Artefacts include:
−
#* Application Overview
+
#* <b>TODO:</b> Application Overview
−
#* Application Quick Start
+
#* <b>TODO:</b> Application Quickstart
−
#* Logo
+
#* The Opticks icon is included with the application and online.
−
#* Graphical Image
+
# <b>TODO:</b> Ideally, stable version(s) of executable applications are bundled with appropriate distributions.<br/><i>In most cases, this will at least include [http://live.osgeo.org OSGeo-Live], but may also include [http://wiki.debian.org/DebianGis DebianGIS], [https://wiki.ubuntu.com/UbuntuGIS UbuntuGIS], and/or [http://trac.osgeo.org/osgeo4w/ osgeo4w] [http://www.maptools.org/ms4w/ ms4w], etc.)</i>
−
# Ideally, stable version(s) of executable applications are bundled with appropriate distributions.<br/><i>In most cases, this will at least include [http://live.osgeo.org OSGeo-Live], but may also include [http://wiki.debian.org/DebianGis DebianGIS], [https://wiki.ubuntu.com/UbuntuGIS UbuntuGIS], and/or [http://trac.osgeo.org/osgeo4w/ osgeo4w] [http://www.maptools.org/ms4w/ ms4w], etc.)</i>
 
  
 
== Projects ==
 
== Projects ==
  
−
Projects do not exist in isolation; and are expected to communicate and collaborate on key issues.  
+
<b>TODO:</b> Projects do not exist in isolation; and are expected to communicate and collaborate on key issues.  
  
 
<i>As an example the PostGIS release procedure asks that the release be checked with MapServer, GeoServer and others.</i>
 
<i>As an example the PostGIS release procedure asks that the release be checked with MapServer, GeoServer and others.</i>
Line 80: Line 80:
  
 
The [[SAC|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:
 
The [[SAC|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.
+
* <b>TODO:</b> A http://projectname.osgeo.org domain name.
  
 
A project may optionally request SAC help to make use of:
 
A project may optionally request SAC help to make use of:
−
* OSGeo issue tracker
+
* OSGeo issue tracker - not requested
−
* OSGeo mailing list
+
* OSGeo mailing list - not requested
−
* OSGeo svn
+
* OSGeo svn - not requested
−
* http://downloads.osgeo.org
+
* http://downloads.osgeo.org - not requested

Latest revision as of 06:20, 10 July 2013

Opticks Incubation Checklist

Completed sections have been filled out, and sections with work remaining to be done have been marked with TODO.

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:
    • LGPL v2.1 License
    • Open communication via IRC and mailing lists
    • Open decision-making via this policy
  2. Active and healthy community:
    • TODO: The project should have a community of developers and users who actively collaborate and support each other in a healthy way.
      Eg. collaboration on project activities such as testing, release and feature development.
    • TODO: Long term viability of the project is demonstrated by showing participation and direction from multiple developers, who come from multiple organisations.
      Eg. The project is resilient enough to sustain loss of a developer or supporting organisation, often referred to as having a high bus factor. Decisions are made openly instead of behind closed doors, which empowers all developers to take ownership of the project and facilitates spreading of knowledge between current and future team members.

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. LGPL v2.1 license.
  2. TODO: Project documentation is available under an open license, such as Creative Commons.
  3. TODO: 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.
  4. TODO: The project maintains a list of all copyright holders identified in the Provenance Review Document.
  5. TODO: All code contributors have agreed to abide by the project's license policy, and this agreement has been documented and archived.

Processes

  1. Configuration management: svn
  2. Issue tracker: [1]
    • Open decision-making via this policy
    • Open communication via IRC and mailing lists

Documentation

  1. The project has user documentation:
  2. The project has developer documentation:
    • Including checkout and build instructions in svn repository.
    • Full documentation of the Opticks C++ SDK, published by doxygen.
    • Contributing patches to Opticks is explained here

Release Procedure

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

  1. TODO: The project follows a defined release process:
    • TODO: Which includes execution of the testing process before releasing a stable release.
  2. TODO: 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.
  3. TODO: Release and testing processes provide sufficient detail for an experienced programmer to follow.

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. TODO: A project provide a Project Officer as a contract point:
    • TODO: The Project Officer should be listed at: Project Officer
    • TODO: This person is established when the incubation committee recommends the project for graduation
    • TODO: 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:
    • TODO: Application Overview
    • TODO: Application Quickstart
    • The Opticks icon is included with the application and online.
  2. TODO: 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.)

Projects

TODO: 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 project may optionally request SAC help to make use of:

  • OSGeo issue tracker - not requested
  • OSGeo mailing list - not requested
  • OSGeo svn - not requested
  • http://downloads.osgeo.org - not requested
Retrieved from "http://wiki.osgeo.org/w/index.php?title=Opticks_Incubation_Checklist&oldid=72308"