diff --git a/README.md b/README.md index a7919503..0647022e 100644 --- a/README.md +++ b/README.md @@ -2,305 +2,11 @@ [](LICENSE) [](https://github.com/X-lab2017/open-digger) [](https://github.com/X-lab2017/open-digger/actions/workflows/node_ci.yml) -OpenDigger is an open source analysis report project for all open source data initiated by [X-lab](https://x-lab.info), this project aims to combine the wisdom of global developers to jointly analyze and insight into open source related data to help everyone better understand and participate in open source. +OpenDigger is an open source analysis platform for all open source data initiated by [X-lab](https://x-lab.info), this project aims to combine the wisdom of global developers to jointly analyze and insight into open source related data to help everyone better understand and participate in open source. -## Metrics or Indices Usage +## Documentation -All implemented metrics are open for anyone to use, you can find the data with following URLs, The root URL of OpenDigger static data is `https://oss.x-lab.info/open_digger/github/` right now since we only have GitHub data for now, just replace the `org/repo` or `owner` to get your data. - -Feel free to use the data to construct your own data application and you can refer OpenDigger as your data source and welcome to use the following badge in your project to show the data source. - -[](https://github.com/X-lab2017/open-digger) - -### For repos - -
Type | Name | From | Example | Code | CodePen | -
---|---|---|---|---|---|
Index | -OpenRank | -X-lab | -openrank.json | -Link | -Demo | -
Activity | -X-lab | -activity.json | -Link | -Demo | -|
Attention | -X-lab | -attention.json | -Link | -Demo | -|
Metric | -Active dates and times | -CHAOSS | -active_dates_and_times.json | -Link | -Demo | -
Stars | -X-lab | -stars.json | -Link | -Demo | -|
Technical fork | -CHAOSS | -technical_fork.json | -Link | -Demo | -|
Participants | -X-lab | -participants.json | -Link | -Demo | -|
New contributors | -CHAOSS | -new_contributors.json | -Link | -||
new_contributors_detail.json | -|||||
Inactive contributors | -CHAOSS | -inactive_contributors.json | -Link | -Demo | -|
Bus factor | -CHAOSS | -bus_factor.json | -Link | -Demo | -|
bus_factor_detail.json | -|||||
Issues new | -CHAOSS | -issues_new.json | -Link | -Demo | -|
Issues closed | -CHAOSS | -issues_closed.json | -Link | -||
Issue comments | -X-lab | -issue_comments.json | -Link | -||
Issue response time | -CHAOSS | -issue_response_time.json | -Link | -Demo | -|
Issue resolution duration | -CHAOSS | -issue_resolution_duration.json | -Link | -Demo | -|
Issue age | -CHAOSS | -issue_age.json | -Link | -Demo | -|
Code change lines | -CHAOSS | -code_change_lines_add.json | -Link | -Demo | -|
code_change_lines_remove.json | -|||||
code_change_lines_sum.json | -|||||
Change requests (Open PR) |
- CHAOSS | -change_requests.json | -Link | -Demo | -|
Change requests accepted (Merged PR) |
- CHAOSS | -change_requests_accepted.json | -Link | -||
Change requests reviews | -CHAOSS | -change_requests_reviews.json | -Link | -||
Change request response time | -CHAOSS | -change_request_response_time.json | -Link | -Demo | -|
Change request resolution duration | -CHAOSS | -change_request_resolution_duration.json | -Link | -Demo | -|
Change request age | -CHAOSS | -change_request_age.json | -Link | -Demo | -|
Activity Details | -X-lab | -activity_details.json | -Link | -Demo | -|
Network | -Developer network | -X-lab | -developer_network.json | -Link | -Demo | -
Repo network | -X-lab | -repo_network.json | -Link | -Demo | -|
Project OpenRank | -X-lab | -project_openrank_detail/2022-12.json | -- | Demo | -
Type | Name | From | Example | Code | CodePen | -
---|---|---|---|---|---|
Index | -OpenRank | -X-lab | -openrank.json | -Link | -Demo | -
Activity | -X-lab | -activity.json | -Link | -Demo | -|
Network | -Developer network | -X-lab | -developer_network.json | -Link | -Demo | -
Repo network | -X-lab | -repo_network.json | -Link | -Demo | -