For continuous integration metadata, we have a "status" field that indicates the overall status of the continuous integration run (e.g. "success" or "failure"). However, for robot comments we did not include an equivalent.
The result of this, is that for the tool to know whether or not the analyses produced messages it has to actually download the referenced Shipshape results, and parse them. This is both expensive and redundant if the analyses produced no messages, so we should add a "status" field indicating the high-level results of the analyses. Since these are robot comments, it makes sense for the status field to have the same potential status as human comments:
"nmw" (Needs More Work) - meaning that the analyses produced messages indicating an issue
"fyi" - meaning that the analyses produced messages that are just informational
"lgtm" (Looks Good To Me) - meaning that the analyses ran successfully, but produced no messages
For continuous integration metadata, we have a "status" field that indicates the overall status of the continuous integration run (e.g. "success" or "failure"). However, for robot comments we did not include an equivalent.
The result of this, is that for the tool to know whether or not the analyses produced messages it has to actually download the referenced Shipshape results, and parse them. This is both expensive and redundant if the analyses produced no messages, so we should add a "status" field indicating the high-level results of the analyses. Since these are robot comments, it makes sense for the status field to have the same potential status as human comments: