From 31e2f41245b1ba7d36a3c603c27da09c59d1e833 Mon Sep 17 00:00:00 2001 From: frank-zsy Date: Mon, 13 Jan 2025 17:34:51 +0800 Subject: [PATCH] docs: update readme Signed-off-by: frank-zsy --- README.md | 300 +----------------------------------------------------- 1 file changed, 3 insertions(+), 297 deletions(-) diff --git a/README.md b/README.md index a7919503..0647022e 100644 --- a/README.md +++ b/README.md @@ -2,305 +2,11 @@ [![apache2](https://img.shields.io/badge/license-Apache%202-blue)](LICENSE) [![](https://img.shields.io/badge/Data-OpenDigger-2097FF)](https://github.com/X-lab2017/open-digger) [![Node.js CI](https://github.com/X-lab2017/open-digger/actions/workflows/node_ci.yml/badge.svg?branch=master)](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://img.shields.io/badge/Data-OpenDigger-2097FF)](https://github.com/X-lab2017/open-digger) - -### For repos - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameFromExampleCodeCodePen
IndexOpenRankX-labopenrank.jsonLinkDemo
ActivityX-labactivity.jsonLinkDemo
AttentionX-labattention.jsonLinkDemo
MetricActive dates and timesCHAOSSactive_dates_and_times.jsonLinkDemo
StarsX-labstars.jsonLinkDemo
Technical forkCHAOSStechnical_fork.jsonLinkDemo
ParticipantsX-labparticipants.jsonLinkDemo
New contributorsCHAOSSnew_contributors.jsonLink
new_contributors_detail.json
Inactive contributorsCHAOSSinactive_contributors.jsonLinkDemo
Bus factorCHAOSSbus_factor.jsonLinkDemo
bus_factor_detail.json
Issues newCHAOSSissues_new.jsonLinkDemo
Issues closedCHAOSSissues_closed.jsonLink
Issue commentsX-labissue_comments.jsonLink
Issue response timeCHAOSSissue_response_time.jsonLinkDemo
Issue resolution durationCHAOSSissue_resolution_duration.jsonLinkDemo
Issue ageCHAOSSissue_age.jsonLinkDemo
Code change linesCHAOSScode_change_lines_add.jsonLinkDemo
code_change_lines_remove.json
code_change_lines_sum.json
Change requests
(Open PR)		CHAOSSchange_requests.jsonLinkDemo
Change requests accepted
(Merged PR)		CHAOSSchange_requests_accepted.jsonLink
Change requests reviewsCHAOSSchange_requests_reviews.jsonLink
Change request response timeCHAOSSchange_request_response_time.jsonLinkDemo
Change request resolution durationCHAOSSchange_request_resolution_duration.jsonLinkDemo
Change request ageCHAOSSchange_request_age.jsonLinkDemo
Activity DetailsX-labactivity_details.jsonLinkDemo
NetworkDeveloper networkX-labdeveloper_network.jsonLinkDemo
Repo networkX-labrepo_network.jsonLinkDemo
Project OpenRankX-labproject_openrank_detail/2022-12.jsonDemo
- -### For users - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameFromExampleCodeCodePen
IndexOpenRankX-labopenrank.jsonLinkDemo
ActivityX-labactivity.jsonLinkDemo
NetworkDeveloper networkX-labdeveloper_network.jsonLinkDemo
Repo networkX-labrepo_network.jsonLinkDemo
- -## Users - -For above data, there are some users of OpenDigger right now. - -### Applications - -- [OpenLeaderboard](https://open-leaderboard.x-lab.info/): A leaderboard of GitHub world with labeled data. -- [Hypercrx](https://github.com/hypertrons/hypertrons-crx): A browser plugin helps to look into GitHub users and repos. -- [Mulan Dashboard](http://dataease.nzcer.cn/link/1VxPsUCX): A dashboard for [Mulan community](https://portal.mulanos.cn/). -- [Hacking Force China](https://opensource.win/): A ranking list of Chinese developers on GitHub cooperate with [SegmentFault](https://segmentfault.com/). - -### Open source reports - -- [China Open Source Report 2021](https://kaiyuanshe.cn/document/china-os-report-2021/): Most comprehensive open source report in China by [kaiyuanshe](https://kaiyuanshe.cn/). -- [China Open Source Blue Paper 2022](http://www.copu.org.cn/new/308): A blue paper of Chinese open source development by [COPU](http://www.copu.org.cn/). -- [Big Data Open Source Heat Report](cooperations/big_data_open_source_heat_report/开源大数据热力报告2022.pdf): A heat report of open source projects in big data area. - -## Events - -OpenDigger community also open to inter-community cooperation events, like contests or hackathons. - -- [PaddlePaddle Hackathon 3rd](https://www.paddlepaddle.org.cn/PaddlePaddleHackathon-2022-6), the hackathon final reports are [here](https://github.com/X-lab2017/open-digger/tree/master/cooperations/paddle_hackathon_3rd). - -## Data - -### GitHub Event Log - -We use [GHArchive](https://www.gharchive.org/) as our data source for GitHub event logs and the data service is provided by [clickhouse](https://clickhouse.tech/) cluster cloud service. For data details, please check the [data](https://github.com/X-lab2017/open-digger/blob/master/docs/data.md) docs. - -### Labeled Data - -We are collecting labeled data for more deeper analysis. You can view the corresponding data in the `labeled_data` folder. For more details, please check [labeled_data](labeled_data/README.md) docs. - -### Sample Data Usage - -OpenDigger provides ClickHouse sample data and Jupyter notebook image to run OpenDigger in local environment, please refer to [sample data doc](./sample_data/README.md). +Please visit the [official website](https://open-digger.cn/) to find more documentation about OpenDigger. ## Communication