Skip to end of metadata
Go to start of metadata

Overview

This maturity model is provided by the Comunity Development PMC and is one way for us to measure our progress toward and readiness for graduation.

The goal of this maturity model is to describe how Apache projects operate, in a concise and high-level way.

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.

It does not describe all the details of how our projects operate, but aims to capture the invariants of Apache projects and point to additional information where needed. To keep the main model as concise as possible we use footnotes for anything that's not part of the core model.

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.

The Apache Project Maturity Model

Each item in the model has a unique ID to allow them to be easily referenced elsewhere.

Code

CodeDescriptionStatusComments
CD10The project produces Open Source software, for distribution to the public at no charge.(tick)

Available from download page with Apache license

http://edgent.incubator.apache.org/docs/downloads

CD20The project's code is easily discoverable and publicly accessible.(tick)See CD10
CD30The code can be built in a reproducible way using widely available standard tools.(tick)Gradle build process documented in DEVELOPMENT.md
CD40

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.

(tick)Source is available here and release is tagged.
CD50The 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.
(tick) 

 

Licenses and Copyright

CodeDescriptionStatusComments
LC10The code is released under the Apache License, version 2.0.(tick)see CD10
LC20

Libraries that are mandatory dependencies of the project's code do not create
more restrictions than the Apache License does.

(tick)All dependencies included in release bundles have licenses compatible with the Apache License and are documented in the LICENSES file in the bundle
LC30The libraries mentioned in LC20 are available as Open Source software.(tick)All libraries are available as Open Source software and documented in the LICENSES file
LC40Committers are bound by an Individual Contributor Agreement (the "Apache iCLA") that defines which code they
are allowed to commit and how they need to identify code that is not their own.
(tick)All committers have signed ICLA's
LC50The copyright ownership of everything that the project produces is clearly defined and documented.(tick)The release bundle LICENSE and NOTICE files are accurate and complete

 

Releases

CodeDescriptionStatusComments
RE10Releases consist of source code, distributed using standard and open archive formats that are expected to stay
readable in the long term.
(tick)See https://edgent.apache.org/docs/downloads
RE20Releases are approved by the project's PMC (see CS10), in order to make them an act of the Foundation.(tick) 
RE30Releases are signed and/or distributed along with digests that can be reliably used to validate the downloaded archives.(tick) 
RE40Convenience binaries can be distributed alongside source code but they are not Apache Releases
-- they are just a convenience provided with no guarantee.
(tick) 
RE50The 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.
(tick)See Release Manager's Guide

 

Quality

CodeDescriptionStatusComments
QU10The 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
(tick)Known issues are tracked in JIRA for public viewing
QU20The project puts a very high priority on producing secure software.  
QU30The project provides a well-documented channel to report security issues, along with a documented way of
responding to them.
 TODO: Add a page to the website with this information.  Suggestion: Issues should be reported to the ppmc,(pmc once we graduate) and a pubic JIRA created when a resolution is available.
QU40The 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.
(tick)Edgent provides documentation on our website and will take care to preserve backward compatibility and announce any changes in behavior that are necessary because of security or other concerns.
QU50The project strives to respond to documented bug reports in a timely manner.(tick)That is the goal and the results so far have generally been good.

 

Community

CodeDescriptionStatusComments
CO10The project has a well-known homepage that points to all the information required to operate according to this
maturity model.
(tick)https://edgent.apache.org/
CO20The community welcomes contributions from anyone who acts in good faith and in a respectful manner and
adds value to the project.
(tick)The project homepage/website makes it clear that contributions are most welcome.  The project has never refused any contributions.
CO30Contributions include not only source code, but also documentation, constructive bug reports, constructive
discussions, marketing and generally anything that adds value to the project.
(tick)The project welcomes and recognizes all contributions that add value to the project.
CO40The community is meritocratic and over time aims to give more rights and responsibilities to contributors
who add value to the project.
(tick)So far three individuals who have shown commitment to the project have been voted in as committers and PPMC members.
CO50The 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. CO60 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.
(tick)Information on how to become a committer is documented here http://edgent.incubator.apache.org/docs/committers.  
CO60The community operates based on consensus of its members (see CS10) who have decision power.
Dictators, benevolent or not, are not welcome in Apache projects.
(tick)In incubation Edgent has been successful in conducting open discussions, encouraging participation and reaching friendly consensus.
CO70The project strives to answer user questions in a timely manner.(tick)That is the goal and the results so far have generally been good.

 

Consensus Building

 

CodeDescriptionStatusComments
CS10The project maintains a public list of its contributors who have decision power -- the project's PMC
(Project Management Committee) consists of those contributors.
(tick)All committers are PMC members and committers are documented at http://incubator.apache.org/projects/edgent.html
CS20Decisions are made by consensus among PMC members 9 and are documented on the project's main
communications channel.
(tick)The project has voted on new committers, PPMC members, and a release using the appropriate channels.
CS30Documented voting rules are used to build consensus when discussion is not sufficient. 10(tick)Edgent uses the Apache rules at http://www.apache.org/foundation/voting.html
CS40In 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.CS50All "important" discussions happen asynchronously
in written form on the project's main communications channel. Offline, face-to-face or private discussions 11 t
hat affect the project are also documented on that channel.
(tick)All decisions are made on the list. 

 

Independence

CodeDescriptionStatusComments
IN10The project is independent from any corporate or organizational influence.(tick)committers and participants that work for corporations appear to understand their Apache hat and make decisions based on the good of the project and appear to be independent.
IN20Contributors act as themselves as opposed to representatives of a corporation or organization.(tick)See IN10

Related efforts, inspiration

Footnotes

  1. "For distribution to the public at no charge" is straight from the from the ASF Bylaws at http://apache.org/foundation/bylaws.html. (1)
  2. See also LC40. (2)
  3. It's ok for platforms (like a runtime used to execute our code) to have different licenses as long as they don't impose reciprocal licensing on what we are distributing. (3)
  4. http://apache.org/legal/resolved.html has information about acceptable licenses for third-party dependencies (4)
  5. In Apache projects, the ASF owns the copyright for the collective work, i.e. the project's releases. Contributors retain copyright on their contributions but grant the ASF a perpetual copyright license for them. (5)
  6. See http://www.apache.org/dev/release.html for more info on Apache releases (6)
  7. The required level of security depends on the software's intended uses, of course. Expectations should be clearly documented. (7)
  8. Apache projects can just point to http://www.apache.org/security/ or use their own security contacts page, which should also point to that. (8)
  9. In Apache projects, "consensus" means widespread agreement among people who have decision power. It does not necessarily mean "unanimity". (9)
  10. For Apache projects, http://www.apache.org/foundation/voting.html defines the voting rules. (10)
  11. Apache projects have a private mailing list that their PMC is expected to use only when really needed. The private list is typically used for discussions about people, for example to discuss and to vote on PMC candidates privately. (11)
  12. Independence can be understood as basing the project's decisions on the open discussions that happen on the project's main communications channel, with no hidden agendas. (12)

 

Copyright © 2013-2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
Apache®, the names of Apache projects, and the feather logo are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries.

  • No labels