GeoNode Incubation Checklist

From OSGeo
Jump to navigation Jump to search

Document Status

Version: 2.0

Last Updated: November 2015.

Status: Draft

Purpose

The purpose of this checklist is to determine whether an Incubator Project produces quality products, remains true to its stated licence and is sustainable. Satisfying this checklist is a pre-requisite for graduation.

A project should have institutionalized the processes in this list or provide justification why the process is not used.

See also:

Terms and Definitions

Mentor
A member of the Incubation Committee chosen to assist a Project through the Incubation Process.
Institutionalized Process
A documented process which which addresses a need and is actively in use. It typically takes months before a process becomes institutionalized. A more detailed definition of institutionalization is found in the Capability Maturity Model (CMMI) - "Generic Goal 2: Institutionalize a Managed Process"
Open Source License
a license recognized by the Open Source Initiative

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:
  2. Active and healthy community: GeoNode has developers and users from many different organizations https://github.com/GeoNode/geonode/blob/master/AUTHORS
    • The project should have a community of developers and users who actively collaborate and support each other in a healthy way. GeoNode has had several code sprints to bring many of the developers together across organizations working with GeoNode. GeoNode actively communicate using the mailing lists as well as other realtime communication such as Gitter.
      Eg. collaboration on project activities such as testing, release and feature development.
    • Long term viability of the project is demonstrated by showing participation and direction from multiple developers, who come from multiple organizations. GeoNode has over 30 core developers who come from both direct users of the software from organizations like the World Bank and US Department of State as well as various professional service providers including Terranodo, Boundless, GeoSolutions, and Open Geode.
      Eg. The project is resilient enough to sustain loss of a developer or supporting organization, 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. All project source code is available under an Open Source license. All GeoNode code is released under the Gnu General Public License version 3 or greater
  2. Project documentation is available under an open license, such as Creative Commons. All documentation is released under the Creative Commons Share Alike License
  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. See https://wiki.osgeo.org/wiki/GeoNode_Provenance_Review#GeoNode_Provenance_Review
  4. The project maintains a list of all copyright holders identified in the Provenance Review Document. Copyright is held by OSGeo.
  5. All code contributors have agreed to abide by the project's license policy, and this agreement has been documented and archived. GeoNode has adpoted a Contributor License Agreement and collecting signatures from past contributors. Future contributions will require a signed CLA

Processes

  1. The project has code under configuration management. All GeoNode code is on GitHub at http://github.org/geonode
    Eg, subversion, git.
  2. The project uses an issue tracker and keeps the status of the issue tracker up to date. GeoNode uses GitHub Issues for tracking
  3. The project has documented its management processes. GeoNode has extensive documentation on all internal process maintained at http://docs.geonode.org/en/master/organizational/index.html


This is typically done within a Developers Guide or Project Management Plan.

    • The project has a suitable open governance policy ensuring decisions are made, documented and adhered to in a public manner. GeoNode as a Project Steering Committee made up of the 7 highest committers over the past 365 days.
    • The project uses public communication channels for decision making to maintain transparency. All decision making is through motions archived on the main development mailing list http://lists.osgeo.org/mailman/listinfo/geonode-devel
      E.g. archived email list(s), archived IRC channel(s), public issue tracker.

Documentation

  1. The project has user documentation: Extensive user documentation is available at http://docs.geonode.org/en/latest/index.html
    • Including sufficient detail to guide a new user through performing the core functionality provided by the application.
  2. The project has developer documentation: Extensive developer documentation is available at http://docs.geonode.org/en/latest/organizational/index.html#contributing
    • Including checkout and build instructions.
    • Including commented code, ideally published for developer use.
      Examples: javadocs for Java applications, or Sphinx documentation for Python applications.
    • Providing sufficient detail for an experience programmer to contribute patches or a new module in accordance with the project's programming conventions.

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:
    • Which includes execution of the testing process before releasing a stable release.
  2. The project follows a documented testing process.
    This includes manual testing
  3. 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. A project provide a Project Officer as a contact point: Yes
    • 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
    • Application Quick Start
    • Logo
    • Graphical Image
  2. Ideally, stable version(s) of executable applications are bundled with appropriate distributions. Yes: OSGeo-Live.
    In most cases, this will at least include OSGeo-Live, but may also include DebianGIS, UbuntuGIS, and/or osgeo4w ms4w, etc.)

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

Retrieved from "http://wiki.osgeo.org/w/index.php?title=GeoNode_Incubation_Checklist&oldid=102531"