You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Introduction

We perform a maturity assessment for IoTDB podling as part of the graduation process for IoTDB from the Apache Incubator.

The assessment is based on the ASF project maturity model at https://community.apache.org/apache-way/apache-project-maturity-model.html

All project members and mentors are welcome to comment or update the assessment.

Maturity assessment status

All items are fine now.

Maturity model assessment

Mentors and community members are encouraged to contribute to this page and comment on it, the following table summarizes the project’s self-assessment against the Apache Maturity Model.


ID

Description

Status

Committers confirmed with the evaluation
Code


CD10The project produces Open Source software, for distribution to the public at no charge.YES hxd
CD20The project's code is easily discoverable and publicly accessible.

YES 

Repo: https://gitbox.apache.org/repos/asf?p=incubator-iotdb.git and https://github.com/apache/incubator-iotdb.

Users can also use "iotdb source code" as keywords on Google and the first item is the repo address.

hxd
CD30The code can be built in a reproducible way using widely available standard tools.

YES 

Just use "./mvnw.sh" or ".\mvnw.bat" to build the source codes in Unix-like and Win OS. The only prerequisite is JDK (>=1.8).

Continuous integration with Travis CI and is used to automate the testing of new commits on Mac/Linux/Windows enovrionments. (https://travis-ci.org/apache/incubator-iotdb/)

Apache's Jenkins server will build the master branch per day. ( https://builds.apache.org/job/IoTDB-Pipeline/job/master/)

hxd
CD40The 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.

YES  

All the history of the project is available through Git.

All releases are properly tagged: https://github.com/apache/incubator-iotdb/tags

ASF has already a clear document to introduce how to release in English. We then prepare a Chinese version for the Instruction for releasing in:

How to release (in English)

 How To release (in Chinese) 如何发布

hxd
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.

YES 

We use git to control the source code. And we will update the messages to only leave meaningful commit messages when merging a PR. 

For new contributors, we have a document to introduce how to submit PRs: http://iotdb.apache.org/Development/HowToCommit.html 

hxd
Licenses and Copyright


LC10The code is released under the Apache License, version 2.0.YES 
https://github.com/apache/incubator-iotdb/blob/master/LICENSE
and 
https://github.com/apache/incubator-iotdb/blob/master/LICENSE-binary
hxd
LC20Libraries that are mandatory dependencies of the project's code do not create more restrictions than the Apache License does.

YES 

All dependencies are Apache 2.0 compatible 

https://www.apache.org/legal/resolved#category-a and 

https://www.apache.org/legal/resolved#category-b

hxd
LC30The libraries mentioned in LC20 are available as Open Source software.

YES 

All dependencies are available as open source software.

hxd
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.

YES 

All committers have completed the ICLA.

hxd
LC50The copyright ownership of everything that the project produces is clearly defined and documented.YES 
All necessary files have a header covering license ownership. This can be verified with the rat task in the build system. Any other copyright information is available in the LICENSE and NOTICE files. https://github.com/apache/incubator-iotdb/blob/master/NOTICE
hxd
Releases


RE10Releases consist of source code, distributed using standard and open archive formats that are expected to stay readable in the long term.

YES 

Users can get them from:

https://downloads.apache.org/incubator/iotdb/

or:

http://iotdb.apache.org/Download/

hxd
RE20Releases are approved by the project's PMC (see CS10), in order to make them an act of the Foundation.

YES 

All incubating releases have been approved by the IoTDB community with at least 3 PPMC votes and by the Incubator with 3 IPMC votes.

hxd
RE30Releases are signed and/or distributed along with digests that can be reliably used to validate the downloaded archives.YES All releases are signed, and the KEYS file is provided on https://downloads.apache.org/incubator/iotdb/KEYShxd
RE40Convenience binaries can be distributed alongside source code but they are not Apache Releases -- they are just a convenience provided with no guarantee.

YES 

Binary releases are available here: http://iotdb.apache.org/Download/

We also provide a Python package and Docker Image:

https://pypi.org/project/apache-iotdb/

https://hub.docker.com/r/apache/iotdb

hxd
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.

YES  
Step-by-step release guide is available describing the entire process both in English and Chinese:

How to release (in English)

 How To release (in Chinese) 如何发布

hxd
Quality


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.

YES 

  1. The project records all bugs in the GitHub issue tracker at https://issues.apache.org/jira/projects/IOTDB/issues
  2. We use Travis-CI to check the UT and ITs.
    https://www.travis-ci.org/apache/incubator-iotdb.svg?branch=master
  3. We will check the test code coverage.   https://coveralls.io/repos/github/apache/incubator-iotdb/badge.svg?branch=master
  4. We use Sonar to check code quality. 
    https://sonarcloud.io/dashboard?id=apache_incubator-iotdb


hxd
QU20The project puts a very high priority on producing secure software.

YES 

Security issues are treated with the highest priority.

hxd
QU30The project provides a well-documented channel to report security issues, along with a documented way of responding to them.

YES 

We follow the generic Apache way of handling security issues. https://www.apache.org/security/ 

 https://www.apache.org/security/committers.html

hxd
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.

YES 

As a database, when the data format or the RPC protocol changes, we have  documents to record that:

http://iotdb.apache.org/Development/format-changelist.html

http://iotdb.apache.org/Development/rpc-changelist.html

Besides, each release contains a "changes" file which contains the release notes.

When releasing new versions, the new version also contains automatically online upgrade tool which can upgrade the data format from v0.[X].* to v0.[X+1].*.   

hxd
QU50The project strives to respond to documented bug reports in a timely manner.

YES 

The project has resolved 480+ issues during incubation.

7 BUG issues left on the jira. 

hxd
Community


CO10The project has a well-known homepage that points to all the information required to operate according to this maturity model.

YES 

The project website has a description of how to contribute code or documentation.

We also have documents about the project with technical details,

And, we have a document introduce how to commit PRs to IoTDB project:

hxd
CO20The community welcomes contributions from anyone who acts in good faith and in a respectful manner and adds value to the project.

YES 

All contributors are welcomed and there are no negative records found through the mailing list search.

We have a code of conduct document to introduce how to be an IoTDB committer:

hxd
CO30Contributions include not only source code, but also documentation, constructive bug reports, constructive discussions, marketing and generally anything that adds value to the project.

YES 

The website refers to documentation contribution guide:

http://iotdb.apache.org/Development/ContributeGuide.html 

and

 http://iotdb.apache.org/Development/Committer.html

hxd
CO40The community is meritocratic and over time aims to give more rights and responsibilities to contributors who add value to the project.

YES 

We have more than 32 committers now and 4 release managers.

The community has elected 9 new committers during incubation, based on meritocracy.

New committers are dong more works, like publishing weekly-reports in our mailing list.

hxd
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.

YES 

 The criteria is documented in the code of conduct document: 

 http://iotdb.apache.org/Development/Committer.html

hxd
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.

YES 

The project works to build consensus. All votes have been unanimous so far.

hxd
CO70The project strives to answer user questions in a timely manner.YES The project typically provides detailed answers to user questions via dev@ mailing list or Jira website.hxd
Consensus Building


CS10The project maintains a public list of its contributors who have decision power -- the project's PMC (Project Management Committee) consists of those contributors.

YES 

The committers list can be found at http://incubator.apache.org/projects/iotdb.html

hxd
CS20Decisions are made by consensus among PMC members and are documented on the project's main communications channel. Community opinions are taken into account but the PMC has the final word if needed.

YES 

The project has been making important decisions on the project mailing lists. Vast majority of, if not all, decisions have had a consensus without any PPMC/Mentor action needed.

hxd
CS30Documented voting rules are used to build consensus when discussion is not sufficient.

YES 

The project uses the standard ASF voting rules. Voting rules are clearly stated before the voting starts for each individual vote.

hxd
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.YES The project hasn’t used a veto now.hxd
CS50All "important" discussions happen asynchronously in written form on the project's main communications channel. Offline, face-to-face or private discussions that affect the project are also documented on that channel.

YES 

The project has been making important decisions on the project mailing lists. Minor decisions may occasionally happen during code reviews, which are also asynchronous and in written form.

hxd
Independence


IN10The project is independent from any corporate or organizational influence.

YES 

The IoTDB community is diverse now. The committers come from Tsinghua University, Microsoft, Alibaba (Flink and RocketMQ team), PragmaticMinds, InfraShield,  NavInfo etc.. 

hxd
IN20Contributors act as themselves as opposed to representatives of a corporation or organization.

YES 

None of the contributors act as representatives of a corporation or organization and only act for themselves.

hxd
  • No labels