First stab at figuring out the number of very active mentors #206

MaineC · 2024-02-13T09:22:09Z

Relates to #114

This is a work in progress pull request. The goal is to extract the number of very active mentors in a project based on number of comments they left in issues and pull requests.

In order to avoid including endless discussion threads that often go in circles the idea is to limit the number of issue comments and pr comments taken into consideration.

This is also where I need input:

As in many other issue-metrics stats I used https://github3.readthedocs.io/en/1.0.1/issues.html#github3.issues.issue.Issue.comments in order to iterate over comments. In the documentation it says the iterator can limit the number of comments considered. In my test case though it seems to ignore this parameter. Likely I mis-understood the use of the iterator?

Readiness Checklist

Author/Contributor

If documentation is needed for this change, has that been included in this pull request
run make lint and fix any issues that you have introduced
run make test and ensure you have test coverage for the lines you are introducing

Reviewer

Label as either bug, documentation, enhancement, infrastructure, or breaking

zkoppert · 2024-03-12T18:46:49Z

most_active_mentors.py

+
+Open questions:
+   - should there be an option to limit this to certain users, e.g. core maintainers?
+   - should there be a limit to how many comments per PR we consider to avoid having


Yes, a limit makes sense to me. It may make sense to say that after 1 comment someone was involved with a PR, and after 3 comments they were heavily involved, and to stop counting after that. Those numbers are my personal thresholds in my mind but could be set to configurable numbers with reasonable defaults.

zkoppert · 2024-03-12T18:48:13Z

most_active_mentors.py

+   - should there be an option to limit this to certain users, e.g. core maintainers?
+   - should there be a limit to how many comments per PR we consider to avoid having
+     the statistic dominated by contested PRs?
+   - should this metric count consecutive comments coming from the same user as only


Great question. In this case I would also consider the length of the comment. If somebody has a lot to say and they break that up into several meaningful comments, I would see that as several contributions worth counting.

zkoppert

I see this as really valuable work! Thanks for working on it! ✨

For larger projects or organizations, it would be especially great to be able to see this data to be able to quickly find active projects that lack mentorship.

zkoppert · 2024-03-14T23:00:40Z

next step for this one looks like working on fixing the tests.

MaineC · 2024-03-26T08:19:40Z

I fixed the linter errors, ran the tests.

Still on my TODO list:

Option to enable/disable this check.
Output of results.

MaineC · 2024-03-26T18:42:25Z

Output added to markdown and call added - and fixed the issues with the original design.

Still missing:

Output in json.
Additional configuration options for disabling this feature and configuring e.g. cutoff for who is considered an active mentor.

MaineC · 2024-03-28T16:01:23Z

In the last commit I added mentor counting results to json output. In addition max number of comments per issue as well as the cutoff number for heavily involved mentors are now configurable.

Tests seem to run through locally, including the ones I added.

make lint left two warnings.

With that I think this is ready for getting a closer look and feedback.

Wish you Happy Easter (no, no Easter eggs hidden here ;) )

…ject.

This adds the call to mentor counter and displays the results in markdown including first tests for this functionality.

This adds two configuration options: One to enable mentor counting and one for configuring how many comments a user needs to leave in discussions, PRs. and issues to be counted as an active mentor.

This adds mentor counting output to json format. In addition this change makes max number of comments to evaluate configurable as well as the cutoff for heavily involved mentors.

MaineC · 2024-03-28T19:06:25Z

Fixed merging errors.

There are two lint warnings still open that I can't figure out.

zkoppert · 2024-03-29T23:40:28Z

I can dig into some of these linting errors. I'll set aside some time this coming week.

Signed-off-by: Zack Koppert <zkoppert@github.com>

zkoppert · 2024-04-02T23:08:47Z

@MaineC I was able to correct the linting errors and override some unreasonable linting rules. Ready to click the ready for review button?

MaineC · 2024-04-03T08:07:18Z

Clicked the button.

jmeridth

Looks good. Just a couple asks. Thank you for your contribution.

config.py

issue_metrics.py

requirements.txt

test_issue_metrics.py

test_most_active_mentors.py

Co-authored-by: Jason Meridth <jmeridth@github.com>

zkoppert · 2024-04-05T23:46:25Z

@MaineC Feel free to review and integrate the change requests from @jmeridth.

Co-authored-by: Jason Meridth <jmeridth@github.com>

Remove merge residual

Remove lib only needed for testing.

Co-authored-by: Jason Meridth <jmeridth@github.com>

MaineC · 2024-04-09T07:28:27Z

Finally back from Easter vacation/ family birthdays/ cold caught after that: Thanks for the feedback. I hope I caught all of the suggestions.

config.py

set type of `enable_mentor_count` to `bool`

change tests to handle boolean change of enable_mentor_count

zkoppert added the enhancement New feature or request label Mar 12, 2024

zkoppert reviewed Mar 12, 2024

View reviewed changes

MaineC force-pushed the active-reviewers branch from 8b788f0 to ebb61da Compare March 26, 2024 08:15

MaineC and others added 8 commits March 28, 2024 17:01

First stab at figuring out the number of very active mentors in a pro…

9867b1b

…ject.

Fix format and linter errors.

a144ed8

Add flake to requirements.

ca13680

Adds call to mentor counter and output in markdown.

0adb1e1

This adds the call to mentor counter and displays the results in markdown including first tests for this functionality.

Make mentor counting configurable.

f041169

This adds two configuration options: One to enable mentor counting and one for configuring how many comments a user needs to leave in discussions, PRs. and issues to be counted as an active mentor.

Adds mentor counting to json output and adds missing config.

0837e49

This adds mentor counting output to json format. In addition this change makes max number of comments to evaluate configurable as well as the cutoff for heavily involved mentors.

Fix merge conflicts.

2c1ebc1

Fix linting errors.

1a01093

MaineC force-pushed the active-reviewers branch from 9133bca to 1a01093 Compare March 28, 2024 19:05

zkoppert added 2 commits April 2, 2024 15:56

fix: linting fixes

ddb16e2

Signed-off-by: Zack Koppert <zkoppert@github.com>

8 is reasonable number of attrs

8f7613b

Signed-off-by: Zack Koppert <zkoppert@github.com>

MaineC marked this pull request as ready for review April 3, 2024 08:06

MaineC requested a review from jmeridth as a code owner April 3, 2024 08:06

jmeridth requested changes Apr 5, 2024

View reviewed changes

Update test_most_active_mentors.py

6c85d10

Co-authored-by: Jason Meridth <jmeridth@github.com>

Update config.py

2506339

Co-authored-by: Jason Meridth <jmeridth@github.com>

MaineC and others added 3 commits April 9, 2024 09:24

Update config.py

c7c8509

Remove merge residual

Update requirements.txt

3bfeec4

Remove lib only needed for testing.

Update issue_metrics.py

c594492

Co-authored-by: Jason Meridth <jmeridth@github.com>

jmeridth reviewed Apr 10, 2024

View reviewed changes

config.py Outdated Show resolved Hide resolved

Update config.py

a0dca05

jmeridth reviewed Apr 10, 2024

View reviewed changes

config.py Outdated Show resolved Hide resolved

jmeridth and others added 3 commits April 10, 2024 23:58

Update config.py

4ba9d3c

set type of `enable_mentor_count` to `bool`

Update test_config.py

3f770f2

change tests to handle boolean change of enable_mentor_count

Merge branch 'main' into active-reviewers

1368741

jmeridth approved these changes Apr 11, 2024

View reviewed changes

jmeridth merged commit eb98ac5 into github:main Apr 11, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

First stab at figuring out the number of very active mentors #206

First stab at figuring out the number of very active mentors #206

MaineC commented Feb 13, 2024 •

edited by zkoppert

zkoppert Mar 12, 2024

zkoppert Mar 12, 2024

zkoppert left a comment

zkoppert commented Mar 14, 2024

MaineC commented Mar 26, 2024

MaineC commented Mar 26, 2024

MaineC commented Mar 28, 2024

MaineC commented Mar 28, 2024

zkoppert commented Mar 29, 2024

zkoppert commented Apr 2, 2024

MaineC commented Apr 3, 2024

jmeridth left a comment

zkoppert commented Apr 5, 2024

MaineC commented Apr 9, 2024

First stab at figuring out the number of very active mentors #206

First stab at figuring out the number of very active mentors #206

Conversation

MaineC commented Feb 13, 2024 • edited by zkoppert

Readiness Checklist

Author/Contributor

Reviewer

zkoppert Mar 12, 2024

Choose a reason for hiding this comment

zkoppert Mar 12, 2024

Choose a reason for hiding this comment

zkoppert left a comment

Choose a reason for hiding this comment

zkoppert commented Mar 14, 2024

MaineC commented Mar 26, 2024

MaineC commented Mar 26, 2024

MaineC commented Mar 28, 2024

MaineC commented Mar 28, 2024

zkoppert commented Mar 29, 2024

zkoppert commented Apr 2, 2024

MaineC commented Apr 3, 2024

jmeridth left a comment

Choose a reason for hiding this comment

zkoppert commented Apr 5, 2024

MaineC commented Apr 9, 2024

MaineC commented Feb 13, 2024 •

edited by zkoppert