Repository files navigation

How to: Show apulse snapshot of the past 6 months of committer activity and issue/PR activity for any git/GitHub repo by doing this:cd into your local clone of any repo, and run the following:

curl -fsSLO https://git-pulse.github.io/tools/git-pulse&& bash ./git-pulse 6

Example output:

           Committers┌────────────────────┬───────┐│      Monthly       │ Cu-   │├─────┬───────┬──────┤ mula- │ Monthly│ New │ Total │ %New │ tive  │ commits             Month range├─────┼───────┼──────┼───────┼───────┬───────────────────────────────────────┐│ 120 │   167 │   71 │  1366 │   385 │ Nov 01 – Dec 01 2021 ending 5mo ago   ││ 115 │   166 │   69 │  1481 │   398 │ Dec 01 – Jan 01 2022 ending 4mo ago   ││ 157 │   221 │   71 │  1638 │   572 │ Jan 01 – Feb 01 2022 ending 3mo ago   ││ 111 │   169 │   65 │  1749 │   468 │ Feb 01 – Mar 01 2022 ending 2mo ago   ││ 163 │   222 │   73 │  1912 │   692 │ Mar 01 – Apr 01 2022 ending 1mo ago   ││ 120 │   192 │   62 │  2032 │   679 │ Apr 01 – May 01 2022 ending today     │└─────┴───────┴──────┴───────┴───────┴───────────────────────────────────────┘ For the last 6 months:     131 new committers per month on average.     189 total active committers per month on average.      69 percent of committers were new committers.     532 commits per month on average. Cumulative total committers grew by 666 (from 1366 to 2032) in 5 months.

┌────────────────┬─────────────────────┐│     Issues     │         PRs         │├────────────────┼─────────────────────┤│ Clsd Opnd   +- │ Mrgd Clsd Opnd   +- │             Month range├────────────────┼─────────────────────┼───────────────────────────────────────┐│  169  215   46 │  373   42  424    9 │ Nov 01 - Dec 01 2021 ending 5mo ago   ││  229  244   15 │  401   36  440    3 │ Dec 01 - Jan 01 2022 ending 4mo ago   ││  223  227    4 │  569   90  669   10 │ Jan 01 - Feb 01 2022 ending 3mo ago   ││  188  195    7 │  470   49  526    7 │ Feb 01 - Mar 01 2022 ending 2mo ago   ││  305  336   31 │  692   55  744   -3 │ Mar 01 - Apr 01 2022 ending 1mo ago   ││  162  199   37 │  673   62  755   20 │ Apr 01 - May 01 2022 ending today     │└────────────────┴─────────────────────┴───────────────────────────────────────┘ For the last 6 months:     212 issues closed per month on average.     236 issues opened per month on average.      23 issue increase in open issues per month on average.     529 PRs merged per month on average.      99 percent merged PRs / commits ratio         (average 529 merged PRs vs average 532 commits).      55 PRs closed (unmerged) per month on average.     593 PRs opened per month on average.       7 PR increase in open PRs per month on average.     140 issue increase in open issues overall.      46 PR increase in open PRs overall.

Apulse snapshot is a report that answers questions about a project — questions such as the following:

• How many contributors are actually active each month?
• How many new contributors is the project gaining each month?
• How many commits are getting merged each month?
• How well is the project managing issues and PRs?
  • How long does an issue or PR typically stay open before it’s resolved?
  • How many issues and PRs are there which have stayed open for a long time without being resolved?
  • At what rate are the lists of open issues and PRs increasing or decreasing?

Thegit-pulse tool generates snapshots with data and graphs that answer those questions.

• The month ranges shown are for logical months based on the current date (today) rather than calendar months. That is, each “month” range shown ends on the same calendar day as today — rather than being a calendar month starting on the 1st of a given month and ending on the 30th, 31st, 28th, or 29th.

• Unless you have eitherGITHUB_TOKEN orGH_TOKEN set in your environment, running this tool will likely cause you to quickly exceed the GitHub API rate limits for requests, and start getting 403 error responses.

• Even withGITHUB_TOKEN/GH_TOKEN set, the tool takes several minutes to run, due to some throttling (delay between API calls) added to avoid hitting GitHub API rate limits for (authenticated) requests.

  To adjust the throttling between API call), run with the-s option set to a number of seconds (default 9):

  bash ./git-pulse -s10

• To generate a snapshot for a date range going back from an earlier day than today, installfaketime (e.g., withapt install faketime orbrew install faketime) and rungit-pulse like this:

  faketime -f "@2021-05-01 23:59:59" bash ./git-pulse

  Note:faketime won’t work on macOS or other systems with the BSDdate command. On such systems, use the-d option to specify the GNUdate command rather than the defaultdate command; for example, on a macOS system, install theHomebrewcoreutils package, and run with the-d option set like this:

  brew install coreutilsfaketime -f "@2021-05-01 23:59:59" bash ./git-pulse -d/usr/local/bin/gdate

• If a repo/clone has a remote namedupstream defined, the tool uses that remote; otherwise it usesorigin.

• Add the directory containing thegit-pulse script to your$PATH, so you can just typegit pulse to run it:

  mkdir git-pulse&&cd git-pulsegit clone https://github.com/git-pulse/tools.gitcd toolsechoexport PATH=\"$PATH:$PWD\">>~/.bash_profile

  Now you can rungit pulse in any repo/clone directory to get a pulse snapshot for that repo.

How to: Generate apulse rankings report in a directory containing multiple*-pulse.json snapshots:

node tools/git-pulse-rank.js