Latest revision as of 01:58, 31 August 2019

Code Provenance Review Process

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

Document Status

Version: 1.1

Status: draft

Last Edited: TBD

Purpose

The purpose of Code Provenance Review is to establish a reasonable comfort level that an Incubation Project does not have improperly contributed code, and that the code is all under the Project license.

A code provenance review is desirable because it reduces the risk to the foundation, to the project developers and to the software users becoming involved in a legal action or having their use of the software disrupted by sudden removal of improperly contributed code. In particular, many enterprises will not build on open source software projects without some degree of assurance that care is being taken to avoid improper contributions.

It is not the goal to be able to prove that every source file, and every contribution to those files, was contributed properly. The onus is not on the IncCom to prove there are no problems. However, IncCom does need to ensure that OSGeo does not officially endorse code with provenance issues that could have identified and corrected with a reasonable effort.

Process

The Code Provenance Review is separated into two sections, each with a slightly different process:

Create a Provenance Review Document by copying the Provenance Review Template.
Complete the Library/Component Review Process.
Complete the Code Copyright Review.
Submit the completed Provenance Review Document to the Project Mentor for review.

Library/Component Review Process

For the overall project, document potential Library/Component issues by:

Listing any external components that are included "in the source tree" for the project. For instance, GDAL includes a copy of libtiff, libjpeg, etc in the source tree. It is necessary to be able to identify things like that in the source tree that are under their own distinct license, and are not explicitly vetted by the project team. If practical, it is desirable to remove these internal components and treat them as external dependencies. If kept internal, notes on the licenses of the components should be documented using the Provenance Review Template.
Listing all external dependencies with:
1. Potentially problematic license terms (all non-free libraries, for instance).
2. All libraries with licenses that might conflict (for instance GDAL's use of GPL'ed GRASS libraries in the non-GPL GDAL).

Code Copyright Review

For each project source file, perform the following:

Does the file include the license information? If not, add it if there there is no ambiguity about whether the standard project license applies. If that is not obvious, make notes in the review document.
Is the file under the normal project license? If not, make notes in the review document.
Is there anything obviously unusual about the origin of the code? Does this pose any conflicts? Is the issue properly described in the source file? For instance, in GDAL, the gdal/port/cpl_strtod.cpp file is closely derived from external code that was placed in the public domain. cpl_strtod.cpp is placed under the normal GDAL MIT/X license, but detailed notes are kept in the header text on it's origin, the fact that this was public domain and so the fact that it is ok to relicense it. Oddities should be noted in the source file itself and in the review document.
Maintain a list of all copyright holders identified in the Provenance Review Document. This list is essentially everyone who would need to agree to relicense the project. It may be desirable to seek copyright assignment to a "project lead", or to the foundation to reduce the number of copyright holders for the project, although this is not required.

Frequently Asked Questions

Do we need to ensure there is a copyright and licence headers in every file?: Projects are expected to embed a copyright and license header in every source file (.cpp and .h for instance). Machine generated files (such as lex or yacc output for instance) does not require a header if it is inconvenient to embed one, but then an effort should be made to embed a header in the original source file (ie. .l or .y). There is no need to embed copyright and license headers in build files (ie. Makefiles, Visual Studio project files), nor in small documentation fragments (like READMEs). Copyright/license headers should be included in substantial bodies of documentation if it can be done in such a way that it doesn't interfere with the document.

Do I really need to embed the whole license agreement in every file?: No, it is sufficient to refer to a single copy of the license agreement for the project, but each file should include an indication of what the license is, and the location of the full license document. For example:

 /*
  * Copyright (C) 2004-2005  Autodesk, Inc.
  * 
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of version 2.1 of the GNU Lesser
  * General Public License as published by the Free Software Foundation.
  *  
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  * 
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */

or:

 * COPYRIGHT:    (C) 2001 by the GRASS Development Team
 *
 *               This program is free software under the GNU General Public
 *               License (>=v2). Read the file COPYING that comes with GRASS
 *               for details.

Can I just write a script to check everything?: No. The point of a human review is to ensure that human eyes have looked at the header of each file, looking for any anomalies. For instance it is not uncommon to have additional messages written in headers about the original source of particular code, but not necessarily in a way that a script could recognise.

But I just did a review similar to this a few months ago, do I really need to do it again?: If you believe you have already met or exceeded the rigor described in this review document, then you can present the results of your previous analysis along with an explanation of why you think it still applies. You will need to manually review additions since that earlier review. It will be up to the Incubator (and ultimately the foundation board) to determine if they are satisfied with any review.

Do I need to track down every contributor and ask for permission to use their code?: No. As long as code was knowingly provided by contributors to the project while it was under a clear licensing policy then it is reasonable to assume the project licensing arrangements are accepted unless there is some reason to have doubts. If code was brought into the project from outside sources under ambiguous circumstances then it may be necessary to contact the copyright holder for a legal release, or at least a statement of permission.

Some project code was adapted from other sources with ambiguous copyrights, what do I do?: First, document such concerns in the review document and within the source files themselves. Second, try to obtain a release to use the provide code. An email statement of permission should be sufficient, but pertinant details of such an email should be included in the source file in questions (eg. date, identification of releasing person, text of the release). If no release is possible, but the code isn't very necessary, consider removing or replacing it to simplify things. Otherwise the issue will need to be discussed in the incubator to assess risk.

Should I be looking for patent problems?: No. However, if the code review turns up notes about patent issues - or if there are known patent issues for the project, then these should be noted in the review document. Generally speaking a proper patent review is very difficult and may increase, rather than decrease, legal liability.

Should I be looking for trademark conflicts?: Possibly. It may be prudent to check for trademark conflicts for the project name, or the name of public packages within the project. If issues are found they should be noted in the review document.

@@ Line 1: / Line 1: @@
-''The following are proposed code provenance review steps.  They are approved as a working draft by the incubation committee, but are not authoritative and will be under continuing revision.''
+=Code Provenance Review Process=
-{{Template:Code_Provenance_Review_Goals}}
+'''The official version of this document lives at: http://www.osgeo.org/incubator/process/project_graduation_checklist.html'''
-= Library/Component Review =
+==Document Status==
-# Prepare a list of any external components that are included "in the source tree" for the project.  For instance, GDAL includes a copy of libtiff, libjpeg, etc in the source tree.  It is necessary to be able to identify things like that in the source tree that are under their own distinct license, and are not explicited vetted by the project team.   If practical it is desirable to remove these internal components and treat them as external depenendencies.  If kept internal, notes on the licenses of the components should be included in the provenance review document.
+'''Version:''' 1.1
-# Prepare a list of external dependencies with with potentially problematic license terms.  So, all non-free libraries for instance.  All libraries with licenses that might conflict (for instance GDAL's use of GPL'ed GRASS libraries in the non-GPL GDAL).
-= Code Copyright Review =
+'''Status:''' draft
-The objective here is to visit every source file, and identify possible issues, and work to "regularize" things.
+'''Last Edited:''' TBD
-# Does the file include the license information?  If not, add it if there there is no ambiguity about whether the standard project license applies.  If that is not obvious, make notes in the review document.
+==Purpose==
-# Is the file under the normal project license?  If not, make notes in the review document.
-# Is there anything obviously unusual about the origin of the code?  Does this pose any conflicts?  Is the issue properly described in the source file?  For instance, in GDAL, the gdal/port/cpl_strtod.cpp file is closely derived from external code that was placed in the public domain.  cpl_strtod.cpp is placed under the normal GDAL MIT/X license, but detailed notes are kept in the header text on it's origin, the fact that this was public domain and so the fact that we are ok to relicense it.  Oddities should be noted in the source file itself and in the review document.
-# Maintain a list of all copyright holders identified in the review document.  This list is essentially everyone who would need to agree to relicense the project.  It may be desirable to seek copyright assignment to a "project lead", or to the foundation to reduce the number of copyright holders for the project though this is not required.
-= Report/Form for Copyright Review =
+The purpose of Code Provenance Review is to establish a reasonable comfort level that an Incubation Project does not have improperly contributed code, and that the code is all under the Project license.
-to be done (TBD) - Brookshier
+A code provenance review is desirable because it reduces the risk to the foundation, to the project developers and to the software users becoming involved in a legal action or having their use of the software disrupted by sudden removal of improperly contributed code. In particular, many enterprises will not build on open source software projects without some degree of assurance that care is being taken to avoid improper contributions.
-= Review Document =
+It is not the goal to be able to prove that every source file, and every contribution to those files, was contributed properly. The onus is not on the IncCom to prove there are no problems. However, IncCom does need to ensure that OSGeo does not officially endorse code with provenance issues that could have identified and corrected with a reasonable effort.
-The result of the provenance review is two fold.  First, there is clarification and "fixes" done during the review.  For instance, adding missing copyright notices, or factoring out external libraries.  The second is a review report with a fairly detailed list of outstanding issues, ambiguities and information of note.
+==Process==
-The review document will be distributed to the project PSC members, as well as the incubation committee.  Based on it, the incubation committee may require the project to do additional work, either resolving ambiguities, factoring items out, or rewriting questional components.
+The Code Provenance Review is separated into two sections, each with a slightly different process:
+# Create a Provenance Review Document by copying the [[Provenance Review Template]].
+# Complete the Library/Component Review Process.
+# Complete the Code Copyright Review.
+# Submit the completed Provenance Review Document to the Project Mentor for review.
-When completed, a much briefer form of the review document should be prepared, just listing information that would be pertinent to folks using the project.  Essentially a summary.  This summary might live in source control as README.LICENSE or something similar.
+==Library/Component Review Process==
-= FAQ =
+For the overall project, document potential Library/Component issues by:
+# Listing any external components that are included "in the source tree" for the project. For instance, GDAL includes a copy of libtiff, libjpeg, etc in the source tree. It is necessary to be able to identify things like that in the source tree that are under their own distinct license, and are not explicitly vetted by the project team. If practical, it is desirable to remove these internal components and treat them as external dependencies. If kept internal, notes on the licenses of the components should be documented using the Provenance Review Template.
+# Listing all external dependencies with:
+## Potentially problematic license terms (all non-free libraries, for instance).
+## All libraries with licenses that might conflict (for instance GDAL's use of GPL'ed GRASS libraries in the non-GPL GDAL).
-; Do we need to ensure there is a copyright and licence headers in every file?
+==Code Copyright Review==
-: Projects are expected to embed a copyright and license header in every source file (.cpp and .h for instance).  Machine generated files (such as lex or yacc output for instance) does not require a header if it is inconvenient to embed one, but then an effort should be made to embed a header in the original source file (ie. .l or .y).  There is no need to embed copyright and license headers in build files (ie. Makefiles, Visual Studio project files), nor in small documentation fragments (like READMEs).  Copyright/license headers should be included in substantial bodies of documentation if it can be done in such a way that it doesn't interfere with the document.
-; Do I really need to embed the whole license agreement in every file?
+For each project source file, perform the following:
-: No, it is sufficient to refer to a single copy of the license agreement for the project, but each file should include an indication of what the license is, and the location of the full license document.  For example:
+# Does the file include the license information? If not, add it if there there is no ambiguity about whether the standard project license applies. If that is not obvious, make notes in the review document.
+# Is the file under the normal project license? If not, make notes in the review document.
+# Is there anything obviously unusual about the origin of the code? Does this pose any conflicts? Is the issue properly described in the source file? For instance, in GDAL, the gdal/port/cpl_strtod.cpp file is closely derived from external code that was placed in the public domain. cpl_strtod.cpp is placed under the normal GDAL MIT/X license, but detailed notes are kept in the header text on it's origin, the fact that this was public domain and so the fact that it is ok to relicense it. Oddities should be noted in the source file itself and in the review document.
+# Maintain a list of all copyright holders identified in the Provenance Review Document. This list is essentially everyone who would need to agree to relicense the project. It may be desirable to seek copyright assignment to a "project lead", or to the foundation to reduce the number of copyright holders for the project, although this is not required.
- /*
+==Frequently Asked Questions==
-  * Copyright (C) 2004-2005  Autodesk, Inc.
-  *
-  * This library is free software; you can redistribute it and/or
-  * modify it under the terms of version 2.1 of the GNU Lesser
-  * General Public License as published by the Free Software Foundation.
-  *
-  * This library is distributed in the hope that it will be useful,
-  * but WITHOUT ANY WARRANTY; without even the implied warranty of
-  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-  * Lesser General Public License for more details.
-  *
-  * You should have received a copy of the GNU Lesser General Public
-  * License along with this library; if not, write to the Free Software
-  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-  */
-: or
+;Do we need to ensure there is a copyright and licence headers in every file?
+:Projects are expected to embed a copyright and license header in every source file (.cpp and .h for instance). Machine generated files (such as lex or yacc output for instance) does not require a header if it is inconvenient to embed one, but then an effort should be made to embed a header in the original source file (ie. .l or .y). There is no need to embed copyright and license headers in build files (ie. Makefiles, Visual Studio project files), nor in small documentation fragments (like READMEs). Copyright/license headers should be included in substantial bodies of documentation if it can be done in such a way that it doesn't interfere with the document.
- * COPYRIGHT:    (C) 2001 by the GRASS Development Team
+;Do I really need to embed the whole license agreement in every file?
- *
+:No, it is sufficient to refer to a single copy of the license agreement for the project, but each file should include an indication of what the license is, and the location of the full license document. For example:
- *               This program is free software under the GNU General Public
+  /*
-  *               License (>=v2). Read the file COPYING that comes with GRASS
+    * Copyright (C) 2004-2005  Autodesk, Inc.
-  *               for details.
+   *
+   * This library is free software; you can redistribute it and/or
+   * modify it under the terms of version 2.1 of the GNU Lesser
+   * General Public License as published by the Free Software Foundation.
+   *
+   * This library is distributed in the hope that it will be useful,
+   * but WITHOUT ANY WARRANTY; without even the implied warranty of
+   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   * Lesser General Public License for more details.
+   *
+   * You should have received a copy of the GNU Lesser General Public
+   * License along with this library; if not, write to the Free Software
+   * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+   */
+or:
-; Can I just write a script to check everything?
+  * COPYRIGHT:    (C) 2001 by the GRASS Development Team
-: No.  The point of a human review is to ensure that human eyes have looked at the header of each file, looking for any anomolies.  For instance it is not uncommon to have additional messages written in headers about the original source of particular code, but not necessarily in a way that a script could recognise.
+  *
+  *               This program is free software under the GNU General Public
+  *               License (>=v2). Read the file COPYING that comes with GRASS
+  *               for details.
+;Can I just write a script to check everything?
+:No. The point of a human review is to ensure that human eyes have looked at the header of each file, looking for any anomalies. For instance it is not uncommon to have additional messages written in headers about the original source of particular code, but not necessarily in a way that a script could recognise.
 ; But I just did a review similar to this a few months ago, do I really need to do it again?
-: If you believe you have already met or exceeded the rigor described in this review document, then you can present the results of your previous analysis along with an explanation of why you think it still applies.  You will need to manually review additions since that earlier review.  It will be up to the Incubator (and ultimately the foundation board) to determine if they are satisfied with any review.
+: If you believe you have already met or exceeded the rigor described in this review document, then you can present the results of your previous analysis along with an explanation of why you think it still applies. You will need to manually review additions since that earlier review. It will be up to the Incubator (and ultimately the foundation board) to determine if they are satisfied with any review.
-; Do I need to track down every contributor and ask for permission to use their code?
+;Do I need to track down every contributor and ask for permission to use their code?
-: No.  As long as code was knowingly provided by contributors to the project while it was under a clear licensing policy then it is reasonable to assume the project licensing arrangements are accepted unless there is some reason to have doubts.  If code was brought into the project from outside sources under ambiguous circumstances then it may be necessary to contact the copyright holder for a legal release, or at least a statement of permission.
+:No. As long as code was knowingly provided by contributors to the project while it was under a clear licensing policy then it is reasonable to assume the project licensing arrangements are accepted unless there is some reason to have doubts. If code was brought into the project from outside sources under ambiguous circumstances then it may be necessary to contact the copyright holder for a legal release, or at least a statement of permission.
-; Some project code was adapted from other sources with ambiguous copyrights, what do I do?
+;Some project code was adapted from other sources with ambiguous copyrights, what do I do?
-: First, document such concerns in the review document and within the source files themselves.  Second, try to obtain a release to use the provide code.  An email statement of permission should be sufficient, but pertinant details of such an email should be included in the source file in questions (eg. date, identification of releasing person, text of the release).  If no release is possible, but the code isn't very necessary, consider removing or replacing it to simplify things.  Otherwise the issue will need to be discussed in the incubator to assess risk.
+:First, document such concerns in the review document and within the source files themselves. Second, try to obtain a release to use the provide code. An email statement of permission should be sufficient, but pertinant details of such an email should be included in the source file in questions (eg. date, identification of releasing person, text of the release). If no release is possible, but the code isn't very necessary, consider removing or replacing it to simplify things. Otherwise the issue will need to be discussed in the incubator to assess risk.
 ; Should I be looking for patent problems?
-: No.  However, if the code review turns up notes about patent issues - or if there are known patent issues for the project, then these should be noted in the review document.  Generally speaking a proper patent review is very difficult and may increase, rather than decrease, legal liability.
+: No. However, if the code review turns up notes about patent issues - or if there are known patent issues for the project, then these should be noted in the review document. Generally speaking a proper patent review is very difficult and may increase, rather than decrease, legal liability.
 ; Should I be looking for trademark conflicts?
-: Possibly.  It may be prudent to check for trademark conflicts for the project name, or the name of public packages within the project.  If issues are found they should be noted in the review document.
+: Possibly. It may be prudent to check for trademark conflicts for the project name, or the name of public packages within the project. If issues are found they should be noted in the review document.
-[[Category:Incubation]]

Difference between revisions of "Code Provenance Review"