Github action to print relevant stats about Pull Request reviewers.

The objective of this action is to:

• Reduce the time taken to review the pull requests.
• Encourage quality on reviews.
• Help to decide which people to assign as reviewers.

Running this action will add a section at the bottom of your pull requests description:

Each reviewer has a link pointing to their historical behavior of each reviewer:

Or send the data to your favorite tools by using the integrations available:

Slack	MS Teams	Webhooks

• No repository data is collected, stored or distributed by this GitHub action. This action is state-less.
• Charts data is send over the URL, and never stored or transmitted anywhere else.
• Minimal data is send to Mixpanel in order to improve this action. However, you can opt-out using telemetry option.

Just add this action to one of your workflow files:

      - name: Run pull request stats
        uses: flowwer-dev/pull-request-stats@master

The possible inputs for this action are:

Minimal config

Add this to the file .github/workflows/stats.yml in your repo:

name: Pull Request Stats

on:
  pull_request:
    types: [opened]

jobs:
  stats:
    runs-on: ubuntu-latest
    steps:
      - name: Run pull request stats
        uses: flowwer-dev/pull-request-stats@master

This config will:

• Calculate the reviewer stats for the current repo in the lasts 30 days
• Add links to the historial data
• Sort results by the "total reviews" column by default

and print a table like this:

	User	Total reviews	Median time to review	Total comments
	jartmez	37	22m	13
	manuelmhtr	35	48m	96
	ernestognw	25	1h 27m	63
	javierbyte	12	30m	0
	Phaze1D	4	34m	1

Visual config

Add this to the file .github/workflows/stats.yml:

name: Pull Request Stats

on:
  pull_request:
    types: [opened]

jobs:
  stats:
    runs-on: ubuntu-latest
    steps:
      - name: Run pull request stats
        uses: flowwer-dev/pull-request-stats@master
        with:
          token: ${{ secrets.ADD_A_PERSONAL_ACCESS_TOKEN }}
          organization: 'piedpiper'
          period: 7
          charts: true
          disable-links: true
          sort-by: 'COMMENTS'

This config will:

• Calculate the reviewer stats for all the repos in the "piedpiper" organization in the lasts 7 days
• Display charts for the metrics
• Remove the links to detailed charts
• Sort results by the "comments" column

and print a table like this:

	User	Total comments	Total reviews	Median time to review
	manuelmhtr 🥇	12 ▀▀▀▀▀▀▀▀	8 ▀▀▀▀	53m
	jartmez 🥈	3 ▀▀	4 ▀▀	58m
	JohanAlvarado 🥉	1 ▀	2 ▀	1d 16h 18m ▀▀▀▀▀▀
	Estebes10	1 ▀	1	19m
	ernestognw	0	2 ▀	2h 15m
	Phaze1D	0	3 ▀	1h 28m
	javierbyte	0	1	21h 24m ▀▀▀

The stats are calculated as following:

• Time to review: It is the time taken by a reviewer from the Pull Request publication or the last Commit push (whatever happens last) to the first time the pull request is reviewed.
• Time to review: It is the median of the times to review of all Pull Requests reviewed by a person in the period.
• Total reviews: It is the count of all Pull Requests reviewed by a person in the period.
• Total comments: It is the count of all the comments while reviewing other user's Pull Requests in the period (comments in own PRs don't count).

Check the guide for the tool you want to integrate:

• Slack
• Microsoft Teams
• Webhooks

This action offers some premium features only for sponsors:

• Disabling telemetry.
• Slack integration.
• Microsoft Teams integration.
• Comming soon: Discord integration, web version.

No minimum amount is required for now. In the future, a minimum monthly sponsorship will be inforced to access premium features.

The minimum suggested sponsorship is $20 usd / month. Thanks for your support! 💙

Used by hundreds of successful teams:

Sixt	Lululemon	Delivery H	JOKR	Lego	LOOP	Hatch	Zenfi
Trivago	Discovery	Addition	Fauna	CDC	Wecasa	Bolt	Republic

	@manuelmhtr 🇲🇽 Guadalajara, MX

This project is maintained by a single person, considering supporting the project by:

• ⭐ Star this repo.
• Sharing your feedback.
• Joining the community.
• Becoming a sponsor.

MIT