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.



  • Authors ( SC_AUTHORS_VOL )

    Provided by: Scancode

    Used by:

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

    Number of authors detected in the code.

  • Number of copyrights ( SC_COPYRIGHTS_VOL )

    Provided by: Scancode

    Used by:

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

    Number of copyrights detected by Scancode in the code base.

  • Total number of files analysed ( SC_FILES_VOL )

    Provided by: Scancode

    Used by:

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

    Total number of files analysed (and documented) by Scancode. Metric is the number of files provided in the list of analysed files returned by Scancode.

  • Automatically generated files ( SC_GENERATED_VOL )

    Provided by: Scancode

    Used by:

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

    Number of files tagged as automatically generated, as detected by Scancode.

  • Code of Conduct ( SC_HAS_CODEOFCONDUCT )

    Provided by: Scancode

    Used by: QM_AGG_ETHICS

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

    The number of files considered as a code of conduct, as detected by Scancode. These can be any initiative and written document to regulate the behaviour of individuals

    As an example, the Eclipse Foundation enforces the following code of conduct: https://www.eclipse.org/org/documents/Community_Code_of_Conduct.php .

  • Has contributing ( SC_HAS_CONTRIBUTING )

    Provided by: Scancode

    Used by: QM_AGG_COLLAB

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

    The number of files considered as a contributing or development guide, as detected by Scancode.

  • Has licence ( SC_HAS_LICENCE )

    Provided by: Scancode

    Used by: QM_AGG_COLLAB

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

    The number of files considered as legal (i.e. licences), as detected by Scancode.

  • Has Readme ( SC_HAS_README )

    Provided by: Scancode

    Used by: QM_AGG_COLLAB

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

    The number of files considered as a readme, as detected by Scancode.

  • Number of copyright holders ( SC_HOLDERS_VOL )

    Provided by: Scancode

    Used by:

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

    Number of copyright holders detected in the code.

  • Licences check ( SC_LIC_CHECK )

    Provided by: Scancode

    Used by: QM_AGG_IP

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

    Unwanted licences in the code, as provided by tools like ScanCode (or Black Duck or..).

    All licences found in the codebase that do not conform to a custom regexp are considered wrong. One should have as few as possible of them.

  • Programming languages ( SC_PROGS_VOL )

    Provided by: Scancode

    Used by:

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

    Number of programming languages detected in the code.

  • Special files ( SC_SPECIAL_FILES )

    Provided by: Scancode

    Used by:

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

    Number of legal, license, readmes, manifests, copyright and other files for key, top-level files.

    Key files are top- level codebase files such as COPYING, README and package manifests as reported by the --classify option 'is_legal', 'is_readme', 'is_manifest' and 'is_top_level' flags.


Page generated by Alambic 3.3.3-dev on Thu Jan 27 17:31:34 2022.