Single-line comments are (IMO) the most useful for developers as they provide context but having them grouped in a review with a comment of its own is still helpful. Except in this case (using both) it makes more sense to make that summary comment different, not a simple concatenation of line comments. I personally would probably prefer to see some summary there about how many violations are there (total or per severity) or how many files are affected or something like that. The current behavior (concatenated violation comments) can probably be set as default for backward compatibility, those comments can be put into one of the possible template variables, alongside the statistics and stuff.
Originally posted this as jenkinsci/violation-comments-to-github-plugin#28 but I was told that changes in this lib are required so reposting here.
Single-line comments are (IMO) the most useful for developers as they provide context but having them grouped in a review with a comment of its own is still helpful. Except in this case (using both) it makes more sense to make that summary comment different, not a simple concatenation of line comments. I personally would probably prefer to see some summary there about how many violations are there (total or per severity) or how many files are affected or something like that. The current behavior (concatenated violation comments) can probably be set as default for backward compatibility, those comments can be put into one of the possible template variables, alongside the statistics and stuff.
Originally posted this as jenkinsci/violation-comments-to-github-plugin#28 but I was told that changes in this lib are required so reposting here.