You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@community.apache.org by cu...@apache.org on 2017/11/17 21:31:46 UTC
svn commit: r1815631 -
/comdev/site/trunk/content/apache-way/apache-project-maturity-model.mdtext
Author: curcuru
Date: Fri Nov 17 21:31:46 2017
New Revision: 1815631
URL: http://svn.apache.org/viewvc?rev=1815631&view=rev
Log:
Organize and improve overview, add IDs to model points; no changes to the model itself. Fixes COMDEV-208
Modified:
comdev/site/trunk/content/apache-way/apache-project-maturity-model.mdtext
Modified: comdev/site/trunk/content/apache-way/apache-project-maturity-model.mdtext
URL: http://svn.apache.org/viewvc/comdev/site/trunk/content/apache-way/apache-project-maturity-model.mdtext?rev=1815631&r1=1815630&r2=1815631&view=diff
==============================================================================
--- comdev/site/trunk/content/apache-way/apache-project-maturity-model.mdtext (original)
+++ comdev/site/trunk/content/apache-way/apache-project-maturity-model.mdtext Fri Nov 17 21:31:46 2017
@@ -1,19 +1,10 @@
Title: A Maturity Model for Apache Projects
-# Status
-This is the first version of this document, as of February 2015.
-
-Updated October 2016 to add RE50.
-
-See <a href="http://s.apache.org/apache_maturity_model">http://s.apache.org/apache_maturity_model</a> for the discussions that led to this. And thanks to the many people who provided input!
-
-Questions and feedback about this model are welcome on the <a href="http://mail-archives.apache.org/mod_mbox/community-dev/">comdev mailing list</a>.
-
-See the <a href="https://github.com/apache/groovy/blob/576b3c5d6a7022ac4a8df1ef118666456ce627fb/MATURITY.adoc">Groovy podling 2015 self-assessment</a> for an example of how to use this
-model to prepare a graduation from the <a href="http://incubator.apache.org">Apache Incubator</a>.
+The **Apache Project Maturity Model** provides a suggested framework for evaluating the overall maturity of an Apache project community and the codebase that it maintains. While this model is specific to Apache projects (i.e. hosted at the ASF) many of these factors are important for any open source project.
# Overview
-The goal of this maturity model is to describe how Apache projects operate, in a concise and high-level way.
+
+The goal of this maturity model is to describe how Apache projects operate, in a concise and high-level way, and to provide a basic framework that projects may choose to use to evaluate themselves.
It is meant to be usable outside of Apache as well, for projects that might want to adopt some or all of these principles. Projects that envision moving to Apache at some point might start working towards this to prepare for their move.
@@ -21,7 +12,9 @@ It does not describe all the details of
Contrary to other maturity models, we do not define staged partial compliance levels. A mature Apache project complies with all the elements of this model, and other projects are welcome to pick and choose the elements that suit their goals.
-Note that we try to avoid using the word "must" below. The model describes the state of a mature project, as opposed to a set of rules.
+Note that we try to avoid using the word "must" below. The model describes the state of a mature project, as opposed to a set of rules. Newer projects in the Incubator might not fit into all the parts of this model; however part of the process of Incubation should tend to move their community behavior to fit the model.
+
+Questions and feedback about this model are welcome on the <a href="http://mail-archives.apache.org/mod_mbox/community-dev/">comdev mailing list</a>.
# The Apache Project Maturity Model
@@ -30,30 +23,30 @@ Each item in the model has a unique ID t
## Code
<dl>
-<dt>CD10</dt>
+<dt id="CD10">CD10</dt>
<dd>
The project produces Open Source software, for distribution to the public at no charge.
<sup><a href="#fnref-a2e0cd066fd8f45af4e87bcdbf8d9abd3ad40872" id="fndef-a2e0cd066fd8f45af4e87bcdbf8d9abd3ad40872-0">1</a></sup>
</dd>
-<dt>CD20</dt>
+<dt id="CD20">CD20</dt>
<dd>
The project's code is easily discoverable and publicly accessible.
</dd>
-<dt>CD30</dt>
+<dt id="CD30">CD30</dt>
<dd>
The code can be built in a reproducible way using widely available standard tools.
</dd>
-<dt>CD40</dt>
+<dt id="CD40">CD40</dt>
<dd>
The full history of the project's code is available via a source code
control system, in a way that allows any released version to be
recreated.
</dd>
-<dt>CD50</dt>
+<dt id="CD50">CD50</dt>
<dd>
The provenance of each line of code is established via the source code control system, in a reliable way based on strong authentication of the
committer. When third-party contributions are committed, commit messages provide reliable information about the code provenance.
@@ -65,29 +58,29 @@ committer. When third-party contribution
## Licenses and Copyright
<dl>
-<dt>LC10</dt>
+<dt id="LC10">LC10</dt>
<dd>The code is released under the Apache License, version 2.0.
</dd>
-<dt>LC20</dt>
+<dt id="LC20">LC20</dt>
<dd>
Libraries that are mandatory dependencies of the project's code do not create more restrictions than the Apache License does.
<sup><a href="#fnref-76d333d056757395d9b6eb1d62e91a57dad757fa" id="fndef-76d333d056757395d9b6eb1d62e91a57dad757fa-2">3</a></sup>
<sup><a href="#fnref-3e4d977daeeb59a808fb0c40477b2cd50e913f2e" id="fndef-3e4d977daeeb59a808fb0c40477b2cd50e913f2e-3">4</a></sup>
</dd>
-<dt>LC30</dt>
+<dt id="LC30">LC30</dt>
<dd>
The libraries mentioned in LC20 are available as Open Source software.
</dd>
-<dt>LC40</dt>
+<dt id="LC40">LC40</dt>
<dd>Committers are bound by an Individual Contributor Agreement (the <a href="http://www.apache.org/licenses/icla.txt">"Apache iCLA"</a>) that
defines which code they are allowed to commit and how they need to
identify code that is not their own.
</dd>
-<dt>LC50</dt>
+<dt id="LC50">LC50</dt>
<dd>
The copyright ownership of everything that the project produces is clearly defined and documented.
<sup><a href="#fnref-258df7a61c975c67bbef17d3cf7851bafd40b8fb" id="fndef-258df7a61c975c67bbef17d3cf7851bafd40b8fb-4">5</a></sup>
@@ -98,28 +91,28 @@ The copyright ownership of everything th
## Releases
<dl>
-<dt>RE10</dt>
+<dt id="RE10">RE10</dt>
<dd>Releases consist of source code, distributed using standard and open archive
formats that are expected to stay readable in the long term.
<sup><a href="#fnref-d2389850862fcc9bddabb3c2e23b13922d68e3fc" id="fndef-d2389850862fcc9bddabb3c2e23b13922d68e3fc-5">6</a></sup>
</dd>
-<dt>RE20</dt>
+<dt id="RE20">RE20</dt>
<dd>
Releases are approved by the project's PMC (see CS10), in order to make them an act of the Foundation.
</dd>
-<dt>RE30</dt>
+<dt id="RE30">RE30</dt>
<dd>
Releases are signed and/or distributed along with digests that can be reliably used to validate the downloaded archives.
</dd>
-<dt>RE40</dt>
+<dt id="RE40">RE40</dt>
<dd>Convenience binaries can be distributed alongside source code but they are not Apache Releases -- they are just a
convenience provided with no guarantee.
</dd>
-<dt>RE50</dt>
+<dt id="RE50">RE50</dt>
<dd>The release process is documented and repeatable to the extent that
someone new to the project is able to independently generate the complete
set of artifacts required for a release.
@@ -131,30 +124,30 @@ set of artifacts required for a release.
## Quality
<dl>
-<dt>QU10</dt>
+<dt id="QU10">QU10</dt>
<dd>The
project is open and honest about the quality of its code. Various levels
of quality and maturity for various modules are natural and acceptable
as long as they are clearly communicated.
</dd>
-<dt>QU20</dt>
+<dt id="QU20">QU20</dt>
<dd>
The project puts a very high priority on producing secure software.
<sup><a href="#fnref-89a5257606b929cc5ced2bee207c80b43541d488" id="fndef-89a5257606b929cc5ced2bee207c80b43541d488-6">7</a></sup>
</dd>
-<dt>QU30</dt>
+<dt id="QU30">QU30</dt>
<dd>
The project provides a well-documented, secure and private channel to report security issues, along with a documented way of responding to them.
<sup><a href="#fnref-7c23a24b04dcf9b4b10423685fbd37f69b2b3783" id="fndef-7c23a24b04dcf9b4b10423685fbd37f69b2b3783-7">8</a></sup>
</dd>
-<dt>QU40</dt>
+<dt id="QU40">QU40</dt>
<dd>The project puts a high priority on backwards compatibility and aims to document any incompatible changes and provide tools and documentation to help users transition to new features.
</dd>
- <dt>QU50</dt>
+ <dt id="QU50">QU50</dt>
<dd>
The project strives to respond to documented bug reports in a timely manner.
</dd>
@@ -164,45 +157,45 @@ The project provides a well-documented,
<dl>
-<dt>CO10</dt>
+<dt id="CO10">CO10</dt>
<dd>
The project has a well-known homepage that points to all the information required to operate according to this maturity model.
</dd>
-<dt>CO20</dt>
+<dt id="CO20">CO20</dt>
<dd>
The community welcomes contributions from anyone who acts in good faith and
in a respectful manner and adds value to the project.
</dd>
-<dt>CO30</dt>
+<dt id="CO30">CO30</dt>
<dd>
Contributions include not only source code, but also documentation, constructive bug
reports, constructive discussions, marketing and generally anything that
adds value to the project.
</dd>
-<dt>CO40</dt>
+<dt id="CO40">CO40</dt>
<dd>
The community is meritocratic and over time aims to give more rights and
responsibilities to contributors who add value to the project.
</dd>
-<dt>CO50</dt>
+<dt id="CO50">CO50</dt>
<dd>
The way in which contributors can be granted more rights such as commit
access or decision power is clearly documented and is the same for all
contributors.
</dd>
-<dt>CO60</dt>
+<dt id="CO60">CO60</dt>
<dd>
The community operates based on consensus of its members (see CS10) who
have decision power. Dictators, benevolent or not, are not welcome in
Apache projects.
</dd>
-<dt>CO70</dt>
+<dt id="CO70">CO70</dt>
<dd>
The project strives to answer user questions in a timely manner.
</dd>
@@ -210,14 +203,14 @@ The project strives to answer user quest
</dl>
## Consensus Building
-<dt>CS10</dt>
+<dt id="CS10">CS10</dt>
<dd>The
project maintains a public list of its contributors who have decision
power -- the project's PMC (Project Management Committee) consists of
those contributors.
</dd>
-<dt>CS20</dt>
+<dt id="CS20">CS20</dt>
<dd>
Decisions are made by consensus among PMC members
<sup><a href="#fnref-08fda1a3461c11086b8542178f35e0c27a4a46c3" id="fndef-08fda1a3461c11086b8542178f35e0c27a4a46c3-8">9</a></sup>
@@ -226,20 +219,20 @@ Community opinions are taken into accoun
if needed.
</dd>
- <dt>CS30</dt>
+ <dt id="CS30">CS30</dt>
<dd>
Documented voting rules are used to build consensus when discussion is not sufficient.
<sup><a href="#fnref-9b0cf71f04bcd81dddbf6199f1c771e27566611e" id="fndef-9b0cf71f04bcd81dddbf6199f1c771e27566611e-9">10</a></sup>
</dd>
- <dt>CS40</dt>
+ <dt id="CS40">CS40</dt>
<dd>In
Apache projects, vetoes are only valid for code commits and are
justified by a technical explanation, as per the Apache voting rules
defined in CS30.
</dd>
-<dt>CS50</dt>
+<dt id="CS50">CS50</dt>
<dd>
All "important" discussions happen asynchronously in written form on the
project's main communications channel. Offline, face-to-face or private discussions
@@ -253,29 +246,46 @@ that affect the project are also documen
<dl>
-<dt>IN10</dt>
+<dt id="IN10">IN10</dt>
<dd>
The project is independent from any corporate or organizational influence.
<sup><a href="#fnref-764b2c2fd32deb4ff73ea01efa67c8556303c359" id="fndef-764b2c2fd32deb4ff73ea01efa67c8556303c359-11">12</a></sup>
</dd>
-<dt>IN20</dt>
+<dt id="IN20">IN20</dt>
<dd>Contributors act as themselves as opposed to representatives of a corporation or organization.
</dd>
</dl>
-# Related efforts, inspiration
+# How To Use The Apache Project Maturity Model
+
+See the <a href="https://github.com/apache/groovy/blob/576b3c5d6a7022ac4a8df1ef118666456ce627fb/MATURITY.adoc">Groovy podling 2015 self-assessment</a> for an example of how to use this
+model to prepare a graduation from the <a href="http://incubator.apache.org">Apache Incubator</a>.
+
+**Remember:** This model is a suggested guide; it is not a requirements document. The model shows what generally good behaviors in an Apache project look like.
+
+## Other Open Source Project Models
+
+See <a href="http://s.apache.org/apache_maturity_model">http://s.apache.org/apache_maturity_model</a> for the discussions that led to this. And thanks to the many people who provided input! The links below are both inspirations for our model above, and are some of the other ways that FOSS project participants have tried to quantify ways to measure open source projects.
+
+* <a href="http://oss-watch.ac.uk/resources/ssmm">http://oss-watch.ac.uk/resources/ssmm</a>
+* <a href="http://osswatch.jiscinvolve.org/wp/2014/12/11/open-or-fauxpen-use-the-oss-watch-openness-rating-tool-to-find-out/">http://osswatch.jiscinvolve.org/wp/2014/12/11/open-or-fauxpen-use-the-oss-watch-openness-rating-tool-to-find-out/</a>
+* <a href="https://blogs.apache.org/comdev/entry/what_makes_apache_projects_different">https://blogs.apache.org/comdev/entry/what_makes_apache_projects_different</a>
+* <a href="http://rfc.zeromq.org/spec:16">http://rfc.zeromq.org/spec:16</a>
+* <a href="http://oss-watch.ac.uk/resources/reusereadinessrating">http://oss-watch.ac.uk/resources/reusereadinessrating</a>
+* <a href="http://en.wikipedia.org/wiki/Capability_Maturity_Model_Integration">http://en.wikipedia.org/wiki/Capability_Maturity_Model_Integration</a>
+* <a href="https://www.apache.org/dev/project-requirements">https://www.apache.org/dev/project-requirements</a>
+
+## Status / Document Version
+
+v 1.0, February 2015, defined by consensus by Apache Community Development project.
+
+v 1.1, October 2016 added RE50.
- * <a href="http://oss-watch.ac.uk/resources/ssmm">http://oss-watch.ac.uk/resources/ssmm</a>
- * <a href="http://osswatch.jiscinvolve.org/wp/2014/12/11/open-or-fauxpen-use-the-oss-watch-openness-rating-tool-to-find-out/">http://osswatch.jiscinvolve.org/wp/2014/12/11/open-or-fauxpen-use-the-oss-watch-openness-rating-tool-to-find-out/</a>
- * <a href="https://blogs.apache.org/comdev/entry/what_makes_apache_projects_different">https://blogs.apache.org/comdev/entry/what_makes_apache_projects_different</a>
- * <a href="http://rfc.zeromq.org/spec:16">http://rfc.zeromq.org/spec:16</a>
- * <a href="http://oss-watch.ac.uk/resources/reusereadinessrating">http://oss-watch.ac.uk/resources/reusereadinessrating</a>
- * <a href="http://en.wikipedia.org/wiki/Capability_Maturity_Model_Integration">http://en.wikipedia.org/wiki/Capability_Maturity_Model_Integration</a>
- * <a href="https://www.apache.org/dev/project-requirements">https://www.apache.org/dev/project-requirements</a>
+(November 2017 this document was clarified, but the model was not changed)
-# Footnotes
+### Footnotes
<ol>