CodeImprover Metrics GitHub app: Commit Report - Explained

Picture is loading...

1) Commit status headline

The Commit status headline has two pieces of information.

  • Failed or Success
    The app reports a boolean true or false back to GitHub. Is an acceptable rating achieved or not?
    The default threshold for approval is a rating of 3.5. Every Rating below the threshold is considered failed.
  • Rating
    The actual rating of the code in this commit.
    Learn more about ratings here

2)  Commit Report

Simply stating that this report is regarding one specific git commit.
(in other words – this is neither a pull request report nor a merge commit report)

3) Summary of the Analysis

The most significant information is the SHA of the child git commit (your new code) and the SHA of the parent git commit (the original code).

4) Observations

This is a list of the observations made by CodeImprover. 

5) Observation Score column

For each observation, the resulting score of points are listed in this column.
Read about observation score points here

Use this to prioritize the effort to raise the code quality

6) Annotations

This is a very detailed list of what observation was done and where it was done. Use this to find the observations that you want to take aktion on.