Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed Update README.md #287

Merged
merged 2 commits into from
Feb 18, 2024
Merged

Fixed Update README.md #287

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65ac30c
Fixed Update README.md
hossain-khan Feb 18, 2024
35e3fcd
Merge branch 'main' into hossain-khan-patch-1
hossain-khan Feb 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ Playground for exploring Github API and collect some PR review stats for differe
This project exist to explore github API to get some common answer about PR review time by different reviewers.

#### What it is NOT
- ❌ It is not a comprehensive GitHub statistics generator tool
- ❌ It is not a comprehensive GitHub statistics generator tool. Built for specific purpose.
- ❌ It is not a modular tool that can be re-used to query GitHub APIs.
- ❌ It does not contain CLI or easy way to run the stats-generator except via **IntelliJ IDE**.
- ❌ Existing supported stats are not localized for different work hour or weekends.
- ❌ It does not follow all industry standards, and does not strive to be performant
- ❌ Existing supported stats are not localized for different work hour or weekends. Only North America time zone supported.
- ❌ It does not follow all industry standards, and does not strive to be performant either.


#### What it is ✔️
- ✅ It can show you PR statistics for PRs created by specific author/contributor of a repository
- ✅ It can generate CSV for the PR stats which can be used in Google Sheets or alike to generate charts
##### Limitation
- 🏋️ It does not collect stats in parallel to avoid GitHub API reate limit and adds delay between API calls
- 🏋️ It does not collect stats in parallel to avoid GitHub API rate-limit and adds delay between API calls
- 🏋️ It is **NOT** able to accurately compute PR review time due to many complexities. The review time is provided for informational purpose only.

## Setup 🛠
Expand All @@ -29,7 +29,7 @@ See [SETUP](SETUP.md) for details on how to setup the project using IntelliJ IDE
The program collects all the related data to user's via different GitHub APIs and compiles releavant data into stats. Those stats are then run through [StatsFormatter](https://github.com/hossain-khan/github-stats/blob/main/src/main/kotlin/dev/hossain/githubstats/formatter/StatsFormatter.kt) to generate files.

Here is an quick overview of how stats generation works.
<img width="600" src="https://user-images.githubusercontent.com/99822/200206579-bba022ea-ebe4-4d5c-9a81-b2c4b6ed6090.jpg"/>
<img alt="Stats Generator Flow" width="600" src="https://user-images.githubusercontent.com/99822/200206579-bba022ea-ebe4-4d5c-9a81-b2c4b6ed6090.jpg"/>


## Sample
Expand Down