Documentation Metrics


All metrics used in the quality model are described thereafter, with useful information and references. They are classified according to their source. Please note also that several other metrics may be retrieved but not used in the quality model.



  • Governance documentation ( DOC_GOV )

    Provided by: EclipsePmi

    Used by: QM_AGG_DECISIONS

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Is there a documentation explaining how decisions are made?

  • Board transparency ( GOV_BOARD_PUBLIC )

    Provided by: EclipsePmi

    Used by: QM_AGG_DECISIONS

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Are the minutes of the board publicly available?

  • Dependency check ( OSS_DEP_CHECK )

    Provided by: EclipsePmi

    Used by: QM_AGG_IP

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Analysis of dependencies to identify old, vulnerable dependencies, as provided by tools like dependency-check or JFrog/Nexus.

    As an example, projects hosted at the Eclipse Foundation have a rigorous IP cleanliness procedure that makes sure that all dependencies meet defined requirements.

  • Escalation procedure ( OSS_ESCALATE )

    Provided by: EclipsePmi

    Used by: QM_AGG_ETHICS

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Is there an easy and visible way for anybody to report toxic behaviour or unfair practices?

    As an example, people willing to report unfair practices or bad behaviour within an Eclipse project can send an email at codeofconduct@eclipse.org.

  • Inclusion initiative ( OSS_INCLUSION )

    Provided by: EclipsePmi

    Used by: QM_AGG_ETHICS

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Is there a formal procedure to help people join and benefit from the community, whoever they are?

    As an example

  • Access information ( PROJECT_ACCESS_INFO )

    Provided by: EclipsePmi , GitLabProject

    Used by: QM_DOC

    Scale: 1 < 0 ≤ 2 < 1 ≤ 3 < 2 ≤ 4 < 3 ≤ 5

    Is the access info (downloads, update sites..) correctly filled in the PMI records?

    The project management infrastructure file holds information about how to access binaries of the project. This test checks the number of access-related entries defined in the PMI: download_url, downloads, update_sites.

  • CI access ( PROJECT_CI_ACCESS )

    Provided by: EclipsePmi

    Used by: QM_AGG_OPENNESS

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Is the continuous integration info correctly filled in the PMI records?

    The project management infrastructure file holds information about the location of CI services. This test checks the number of ci-related entries defined in the PMI.

  • CI information ( PROJECT_CI_INFO )

    Provided by: EclipsePmi , GitLabProject

    Used by: QM_AGG_DOC

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Is the continuous integration info correctly filled in the PMI records?

    The project management infrastructure file holds information about the location of CI services. This test checks the number of ci-related entries defined in the PMI.

  • DL access ( PROJECT_DL_ACCESS )

    Provided by: EclipsePmi

    Used by: QM_AGG_OPENNESS

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Is the access info (downloads, update sites..) correctly filled in the PMI records?

    The project management infrastructure file holds information about how to access binaries of the project. This test checks the number of access-related entries defined in the PMI: download_url, downloads, update_sites.

  • DL information ( PROJECT_DL_INFO )

    Provided by: EclipsePmi

    Used by: QM_AGG_DOC

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Is the access info (downloads, update sites..) correctly filled in the PMI records?

    The project management infrastructure file holds information about how to access binaries of the project. This test checks the number of access-related entries defined in the PMI: download_url, downloads, update_sites.

  • Doc access ( PROJECT_DOC_ACCESS )

    Provided by: EclipsePmi

    Used by: QM_AGG_OPENNESS

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Is the documentation info correctly filled in the PMI records?

    The project management infrastructure file holds information about various documentation and manuals. This test checks the number of doc-related entries defined in the PMI: build_doc, documentation, documentation_url, forums, gettingstarted_url, mailing_lists, website_url, wiki_url.

  • Docs information ( PROJECT_DOC_INFO )

    Provided by: EclipsePmi , GitLabProject

    Used by: QM_AGG_DOC , QM_DOC

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Is the documentation info correctly filled in the PMI records?

    The project management infrastructure file holds information about various documentation and manuals. This test checks the number of doc-related entries defined in the PMI: build_doc, documentation, documentation_url, forums, gettingstarted_url, mailing_lists, website_url, wiki_url.

  • Getting started ( PROJECT_GETTINGSTARTED_INFO )

    Provided by: EclipsePmi

    Used by: QM_AGG_COLLAB

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Is the documentation info correctly filled in the PMI records?

    The project management infrastructure file holds information about various documentation and manuals. This test checks the number of doc-related entries defined in the PMI: build_doc, documentation, documentation_url, forums, gettingstarted_url, mailing_lists, website_url, wiki_url.

  • ITS access ( PROJECT_ITS_ACCESS )

    Provided by: EclipsePmi

    Used by: QM_AGG_OPENNESS

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Is the bugzilla info correctly filled in the PMI records?

    The project management infrastructure file holds information about one or more bugzilla instances. This test checks that at least one bugzilla instance is defined, with a product identifier, a create_url to enter a new issue, and a query_url to fetch all the issues for the project.

  • ITS information ( PROJECT_ITS_INFO )

    Provided by: EclipsePmi , GitLabProject

    Used by: QM_AGG_DOC , QM_DOC

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 1 ≤ 4 < 2 ≤ 5

    Is the bugzilla info correctly filled in the PMI records?

    The project management infrastructure file holds information about one or more bugzilla instances. This test checks that at least one bugzilla instance is defined, with a product identifier, a create_url to enter a new issue, and a query_url to fetch all the issues for the project.

  • MLS access ( PROJECT_MLS_ACCESS )

    Provided by: EclipsePmi

    Used by: QM_AGG_OPENNESS

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Is the communication channel for the team info correctly filled in the PMI records?

    The project management infrastructure file holds information about the various communication means used by the project. This test checks the number of MLS-related entries defined in the PMI: mailing lists, forums, etc.

  • MLS information ( PROJECT_MLS_INFO )

    Provided by: EclipsePmi

    Used by: QM_AGG_DOC

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 1 ≤ 4 < 2 ≤ 5

    Is the communication channel for the team info correctly filled in the PMI records?

    The project management infrastructure file holds information about the various communication means used by the project. This test checks the number of MLS-related entries defined in the PMI: mailing lists, forums, etc.

  • Number of releases ( PROJECT_REL_VOL )

    Provided by: EclipsePmi

    Used by: QM_REL_ENG

    Scale: 1 < 1 ≤ 2 < 3 ≤ 3 < 5 ≤ 4 < 10 ≤ 5

    The number of releases recorded in the PMI.

    Milestones are retrieved from the PMI file and are counted whatever their target release is. Milestones are useful to assess the maturity of the release and improves predictability of the project's output, in terms of quality and time.

  • SCM access ( PROJECT_SCM_ACCESS )

    Provided by: EclipsePmi

    Used by: QM_AGG_OPENNESS

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 0 ≤ 4 < 1 ≤ 5

    Is the source_repo info correctly filled in the PMI records?

    The project management infrastructure file holds information about one or more source repositories. This test checks that at least one source repository is defined, and accessible.

  • SCM information ( PROJECT_SCM_INFO )

    Provided by: EclipsePmi , GitLabProject

    Used by: QM_AGG_DOC , QM_DOC , QM_SCM

    Scale: 1 < 0 ≤ 2 < 0 ≤ 3 < 1 ≤ 4 < 2 ≤ 5

    Is the source_repo info correctly filled in the PMI records?

    The project management infrastructure file holds information about one or more source repositories. This test checks that at least one source repository is defined, and accessible.


Page generated by Alambic 3.3.3-dev on Thu Jan 27 17:37:55 2022.