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.



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

  • Project authors ( PROJECT_AUTHORS )

    Provided by: GitLabProject

    Used by:

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

    Total number of identities found as authors of commits in source code management repository.

    Source code management repositories are those considered as such in the project documentation. Commits in all branches are considered. Date used for each commit is 'author date' (when there is a difference between author date and committer date). An identity is considered as author if it appears as such in the commit record (for systems logging several identities related to the commit, authoring identity will be considered).

  • Project authors one month ( PROJECT_AUTHORS_1M )

    Provided by: GitLabProject

    Used by:

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

    Total number of identities found as authors of commits in source code management repositories dated during the last month.

    Source code management repositories are those considered as such in the project documentation. Date used for each commit is 'author date' (when there is a difference between author date and committer date). Time range is measured as a one month period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).

  • Project authors one week ( PROJECT_AUTHORS_1W )

    Provided by: GitLabProject

    Used by:

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

    Total number of identities found as authors of commits in source code management repositories dated during the last week.

    Source code management repositories are those considered as such in the project documentation. Date used for each commit is 'author date' (when there is a difference between author date and committer date). Time range is measured as a one week period starting the day before the data retrieval.

  • Project authors one year ( PROJECT_AUTHORS_1Y )

    Provided by: GitLabProject

    Used by:

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

    Total number of identities found as authors of commits in source code management repositories dated during the last year.

    Source code management repositories are those considered as such in the project documentation. Date used for each commit is 'author date' (when there is a difference between author date and committer date). Time range is measured as a one year period starting the day before the data retrieval (example: if retrieval is on Feb 3rd 2016, period is from Feb 3rd 2015 to Feb 3rd 2016, both included).

  • CI information ( PROJECT_CI_INFO )

    Provided by: EclipsePmi , GitLabProject

    Used by:

    Scale: 1 < 0 ≤ 2 < 2 ≤ 3 < 4 ≤ 4 < 6 ≤ 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.

  • Project Commits ( PROJECT_COMMITS )

    Provided by: GitLabProject

    Used by:

    Scale: 1 < 2 ≤ 2 < 5 ≤ 3 < 13 ≤ 4 < 121 ≤ 5

    Total number of commits in source code management repositories.

    Source code management repositories are those considered as such in the project documentation. Date used for each commit is 'author date' (when there is a difference between author date and committer date).

  • Project Commits one month ( PROJECT_COMMITS_1M )

    Provided by: GitLabProject

    Used by:

    Scale: 1 < 2 ≤ 2 < 5 ≤ 3 < 13 ≤ 4 < 121 ≤ 5

    Total number of commits in source code management repositories dated during the last month.

    Source code management repositories are those considered as such in the project documentation. Date used for each commit is 'author date' (when there is a difference between author date and committer date). Time range is measured as a one month period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).

  • Project Commits one week ( PROJECT_COMMITS_1W )

    Provided by: GitLabProject

    Used by:

    Scale: 1 < 2 ≤ 2 < 5 ≤ 3 < 13 ≤ 4 < 121 ≤ 5

    Total number of commits in source code management repositories dated during the last week.

    Source code management repositories are those considered as such in the project documentation. Date used for each commit is 'author date' (when there is a difference between author date and committer date). Time range is measured as a one week period starting the day before the data retrieval.

  • Project Commits one year ( PROJECT_COMMITS_1Y )

    Provided by: GitLabProject

    Used by:

    Scale: 1 < 2 ≤ 2 < 5 ≤ 3 < 13 ≤ 4 < 121 ≤ 5

    Total number of commits in source code management repositories dated during the last year.

    Source code management repositories are those considered as such in the project documentation. Date used for each commit is 'author date' (when there is a difference between author date and committer date). Time range is measured as a one year period starting the day before the data retrieval (example: if retrieval is on Feb 3rd 2016, period is from Feb 3rd 2015 to Feb 3rd 2016, both included).

  • Project committers ( PROJECT_COMMITTERS )

    Provided by: GitLabProject

    Used by:

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

    Total number of identities found as committers of commits in source code management repository.

    Source code management repositories are those considered as such in the project documentation. Commits in all branches are considered. Date used for each commit is 'committer date' (when there is a difference between author date and committer date). An identity is considered as committer if it appears as such in the commit record.

  • Project committers one month ( PROJECT_COMMITTERS_1M )

    Provided by: GitLabProject

    Used by:

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

    Total number of identities found as committers of commits in source code management repositories dated during the last month.

    Source code management repositories are those considered as such in the project documentation. Date used for each commit is 'committer date' (when there is a difference between author date and committer date). Time range is measured as a one month period starting the day before the data retrieval (example: if retrieval is on Feb 3rd, period is from Jan 3rd to Feb 2nd, both included).

  • Project committers one week ( PROJECT_COMMITTERS_1W )

    Provided by: GitLabProject

    Used by:

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

    Total number of identities found as committers of commits in source code management repositories dated during the last week.

    Source code management repositories are those considered as such in the project documentation. Date used for each commit is 'committer date' (when there is a difference between author date and committer date). Time range is measured as a one week period starting the day before the data retrieval.

  • Project committers one year ( PROJECT_COMMITTERS_1Y )

    Provided by: GitLabProject

    Used by:

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

    Total number of identities found as committers of commits in source code management repositories dated during the last year.

    Source code management repositories are those considered as such in the project documentation. Date used for each commit is 'committer date' (when there is a difference between author date and committer date). Time range is measured as a one year period starting the day before the data retrieval (example: if retrieval is on Feb 3rd 2016, period is from Feb 3rd 2015 to Feb 3rd 2016, both included).

  • Doc information ( PROJECT_DOC_INFO )

    Provided by: EclipsePmi , GitLabProject

    Used by: QM_DOC

    Scale: 1 < 0 ≤ 2 < 2 ≤ 3 < 4 ≤ 4 < 6 ≤ 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.

  • Number of forks ( PROJECT_FORKS )

    Provided by: GitLabProject

    Used by:

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

    The number of forks for this project. More forks usually mean a greater activity.

  • Open issues ( PROJECT_ISSUES_OPEN )

    Provided by: GitLabProject

    Used by:

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

    The number of issues opened at the time of analysis on the GitLab project.

    This information is retrieved from GitLab itself, and may differ from numbers gathered from the actual issue tracking system used.

  • ITS information ( PROJECT_ITS_INFO )

    Provided by: EclipsePmi , GitLabProject

    Used by: QM_DOC

    Scale: 1 < 2 ≤ 2 < 3 ≤ 3 < 4 ≤ 4 < 5 ≤ 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.

  • Last activity ( PROJECT_LAST_ACTIVITY_AT )

    Provided by: GitLabProject

    Used by:

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

    The date of last activity for this project. This includes any type of action: changes on issues, git commits or pushes, merge requests, comments...

    A project with a old last activity timestamp shows the project is dead (or in agony at least).

  • SCM information ( PROJECT_SCM_INFO )

    Provided by: EclipsePmi , GitLabProject

    Used by: QM_DOC , QM_SCM

    Scale: 1 < 0 ≤ 2 < 1 ≤ 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.

  • Number of stars ( PROJECT_STARS )

    Provided by: GitLabProject

    Used by:

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

    The number of times people have starred this project. Users use stars to show their interest for a project, and more stars usually mean a greater visibility and interest.


Page generated by Alambic 3.3.3-dev on Mon Aug 19 01:42:17 2019.