Comments on Sample Reports

germonprez commented 4 years ago

Please use this issue to provide comments on the Sample CHAOSS Community Reports. You can find the two sample reports here. The difference between the two reports is simply the ordering of the graphs.

https://github.com/chaoss/health-reports/tree/master/sample-reports

germonprez commented 4 years ago

Comment from today's CHAOSS community call -- Include a version of the report. This first version would be labeled:

V1.0

klumb commented 4 years ago

V1.0

General Notes:

Even with a logo, it isn’t clear which repository(s) the report is for. A URL would be nice.
Links to CHAOSS metric definitions, foot notes, or a supplemental sheet with definitions might be nice.
Three of the four data visualizations are pointed at PR/Commits. May want to keep them together by swapping the two cauldron visuals. Issues open and closed would then be the last visual (alternately you could move it to the first followed by the three related visuals). It looks like this was fixed in Version 2.

Mean Duration of All Closed Pull Requests:

Pull Request is not CHAOSS terminology
Are the grey bars important? None of the other colors make a point of mentioning PRs were opened. Could the grey bars just be white?

Drive-by and Repeat Contributor Counts per Month:

Contributor isn’t defined.
…and the data likely doesn’t match CHAOSS definition of contributor

Number of Commits by Weekday:

It might be interesting to provide the median number of commits per day for the time period in addition to the totals

Nebrethar commented 4 years ago

Quick Note - We have some words that are not consistent.

I see "Opened Issues" in text, "Open" in a header, and "Created" appears in the issue graph in reference to open issues.

Please ensure that language is consistent

sgoggins commented 4 years ago

@klumb : The evolution working group has consensus that the CHAOSS term "Reviews" is prone to misunderstanding. We can find a way to footnote this point, but I think calling it "Reviews" in the report would be confusing.

sgoggins commented 4 years ago

@klumb : The data does match the CHAOSS definition of contributor, but it does apply six filters, which are more clear on a different graphic we could use.

klumb commented 4 years ago

@sgoggins regarding reviews, I think it is fair to use an alternate name but I think we need to figure out a way to connect it back to CHAOSS work.

sgoggins commented 4 years ago

@klumb : Contributor is the CHAOSS Definition of Contributor. Putting "too much" on the report has been a pressing concern as we have strived to keep it to one page.

sgoggins commented 4 years ago

@klumb : we can easily define "contributor" and "drive by contributor" in the caption. For many of these questions we are going to have to strike a balance between space and caption length.

chaoss / community-reports

Comments on Sample Reports #3