Project Graduation Checklist

From OSGeo
Jump to navigation Jump to search

The official copy of this document lives at http://www.osgeo.org/incubator/process/project_graduation_checklist.html

Wiki version 50824 of this document was discussed at Incubation Meeting 14, and a number of suggested changes were made. Logs here: http://irclogs.geoapt.com/osgeo/%23osgeo.2010-03-03.log

Document Status

IncCom Document Number: X

Version: 2.0. Updates since 1.0 are in red.

Last Updated: January 2012.

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.

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"

Checklist

The following checklist is used during graduation to ensure we have not missed anything. Cameron Shorter comment: This sentence is covered under the "Purpose" heading above, hence it doesn't need repeating here.

Intellectual Property and LicenseLicense

We need to ensure that project owns or otherwise has obtained the ability to release:

  1. The project code, documentation and data has been adequately vetted to assure it is all properly licensed (a.k.aas per a provenance review.
  2. All code contributors have agreed to abide by the project's license policy, and this agreement has been documented and archived.
  3. Any other legal checks such as trademark and patent.The project has checked for inappropriate use of trademark or patents and the results of such checks have been documented.Cameron Shorter comment: This point needs to be definitive if it is included. Also, I think that it should be included in the "Provenance Review" checklist (which could be renamed "Legal Checklist"). And before it is included (which I think is a good idea long term), we need to do an audit of existing graduated projects to see if they would pass. Hence, I suggest that inclusion of this point be delayed until a future version of this document.
  4. The project has the ability to shut off downloads if a blocking legal issue is found.

Processes

Documented processes: Cameron Shorter comment: This line isn't required if you have "Processes" heading above.

  1. The project has code under configuration managementcontrol. Eg, subversion, git.
  2. The project uses an issue tracker and keeps the status of the issue tracker up to date.
  3. The project has documented its management processes. 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. 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.
    • 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.

#* See Documentation and Release Procedure for more information Cameron Shorter comment: This line is out of place in a check list (Also this doc is short enough that we don't need to reference another heading).

This checklist can only document process requirements; the goal of the above procedures is to check that the developer community works in a healthy way:

  • Open Development: open to input, new members and reaching consensus on decisions.
  • Ideally, the developers and Project Management Committee members come from a diversity of backgrounds as there will be a greater variety of technical visions and the project is more resilient to a sponsor leaving.

Cameron Shorter comment: Covered in list above.

Documentation

We ask that extra care be taken to ensure high quality documentation and releases:

  1. The project has user documentation:
    • Including sufficient detail to guide a new user through performing the core functionality provided by the application.
  2. The project has developer documentation:
    • 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

It is not enough to make and document a release; the goal of the above checklist is to focus team reliability:

  • Ideally we would like a new developer to walk up; follow the instructions and correctly engage the community to build a release

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

  1. The project followshas a defined release process:
    • Which includes execution of the testing process before releasing a stable release.
  2. The project has an automated build process. The project follows a documented testing process: manages quality
    • Ideally, this includes both automated and manual testingan automated test system.
    • Ideally this includes documentation conformance to set quality goals, such as reporting Percentage Code Coverage of Unit Tests.
  3. Release and testing processes provide sufficient detail for an experienced programmer to follow.
  • Cameron Shorter comment: At a later stage, it would be good to expect OSGeo projects to maintain a periodic stable release schedule, ideally linked in with distribution release cycles. However, I don't think we have reached that level of maturity across our projects yet.
  • Jody Garnett comment: You will need an OSGeo project as a good example before asking for a Quality Process. Example: GeoTools mandates modules obtain 40% code coverage prior to being published

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. Participation is optional but recommended. Cameron Shorter comment: The items listed in this section should all be addressed during incubation (or an explanation provided as to why it hasn't been addressed).

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 - please help them out with the following information. The Marketing Committee requests:

  1. Marketing materialartefacts have been created about the project forin line with the incubation criteria listed in the OSGeo Marketing Committee's Marketing Artefacts. This lists the documentation requirements for OSGeo-Live. (can we assume pdf handout, presentation slides and a feature matrix?) Marketing Artefacts include:
    • Application Overview
    • Application Quick Start
    • Logo
    • Graphical Image
  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.)

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

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