flowwer-dev / pull-request-stats

Github action to print relevant stats about Pull Request reviewers
MIT License
366 stars 79 forks source link

doc: Total comments #98

Open rowi1de opened 1 month ago

rowi1de commented 1 month ago

Could you clarify which comments count towards the following:

manuelmhtr commented 1 month ago

Hello @rowi1de, great question. I've updated the documentation as follows:

  • Total comments: The number of comments made while reviewing other users' Pull Requests during the specified period. Comments made on your own PRs or general PR discussions are excluded; only comments directly related to code are counted.

At the moment, only code-related comments are included (ALL of them, since any normal comment on code generates a review). However, I realize that general comments in reviews are also important (those when submitting a review). I plan to include them in the statistics in a future update.

rowi1de commented 1 month ago

Hey @manuelmhtr I would say this should be an option to enable. For code comments it is more clear that it is relevant. For the general comment it could also just be LGTM.