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.

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

docs: add multiple new metrics (EN + ZH) #28

Merged
merged 7 commits into from
Jul 20, 2024

Conversation

Neilblaze
Copy link
Member

@Neilblaze Neilblaze commented Jul 11, 2024

Description

Fixed typo in Bus Factor, updated dependencies to latest & added new metrics (both EN & ZH), for the following, mentioned below (includes updates from 20/04/2024) :

  • Activity Details
  • Activity Dates and Times
  • Inactive Contributors
  • Issue Resolution Duration
  • Issue Response Time

🦄 Tested on local, build running successfully!

Ref : Slack Discussion / cc: @Peng99999, @frank-zsy
Partially resolves #24

Before submitting the PR, please take the following into consideration

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. If you don't have an issue, please create one.
  • Prefix your PR title with feat: , fix: , chore: , docs:, or refactor:.
  • The description should clearly illustrate what problems it solves.
  • Ensure that the commit messages follow our guidelines.
  • Resolve merge conflicts (if any).
  • Make sure that the current branch is upto date with the main branch.

@Neilblaze Neilblaze changed the title New metrics v1 docs: add multiple new metrics (EN + ZH) Jul 11, 2024
@frank-zsy
Copy link
Contributor

Thanks for the docs. I will update the Chinese version.

I think you should start with CHAOSS statistical metrics since they are quite easy and have CHAOSS documentations as reference.

Metrics from X-lab are almost complex metrics involves calculation or even graph data structure, so we can add them at last.

@frank-zsy
Copy link
Contributor

Actually time period related metrics like resolution duration and response time are also tricky. So these metrics will involve deep collaboration with me.

@Neilblaze
Copy link
Member Author

Thanks for the docs. I will update the Chinese version.

Sounds good, thank you! 😄

I think you should start with CHAOSS statistical metrics since they are quite easy and have CHAOSS documentations as reference.

I see, thanks for the heads up! Alright, I'll prioritize CHAOSS metrics first, and once those are completed, I'll start digging into the X-lab metrics with your guidance.

Metrics from X-lab are almost complex metrics involves calculation or even graph data structure, so we can add them at last.

Got it!

@frank-zsy
Copy link
Contributor

/preview

Copy link

🪧The website for this PR is deployed at https://open-digger.cn/pull_28/

@frank-zsy
Copy link
Contributor

@Neilblaze I add LaTeX support and modify the docs, could you modify the English version due to my modification? Especially activity metrics. And activity and activity details are both included in the activity part now.

And I think we can remove the English name of each metrics in the Chinese doc titles and we do not need to translate Issue and PR.

@Neilblaze
Copy link
Member Author

Yessir, I'll do that :)

Neilblaze and others added 3 commits July 20, 2024 18:40
@Neilblaze
Copy link
Member Author

/preview

Copy link

🪧The website for this PR is deployed at https://open-digger.cn/pull_28/

@frank-zsy
Copy link
Contributor

/preview

Copy link

🪧The website for this PR is deployed at https://open-digger.cn/pull_28/

@frank-zsy
Copy link
Contributor

This PR LGTM now. Thanks for the great work!

I will merge this PR now and further more:

  • I think change request response time and resolution duration could be merged with issue corresponding metrics.
  • Pls feel free to raise PR and discuss on GitHub, since Slack is not quite stable in China, I can only receive the notification but can not retrieve the messages smoothly. Sorry for that.

@frank-zsy frank-zsy merged commit e43b981 into X-lab2017:master Jul 20, 2024
1 check passed
@Neilblaze
Copy link
Member Author

Neilblaze commented Jul 21, 2024

@frank-zsy Thanks for merging the PR! 😃

I think change request response time and resolution duration could be merged with issue corresponding metrics.

Sure thing! In the next PR, I'll make sure to do this. But I'm also a little curious, (assuming that I haven't misinterpreted what you mentioned) what I can see is that if we're aiming to keep a standalone section for issue corresponding metrics, there are six of them, that we'll have to handle:

image

Do you have any thoughts regarding this?


Pls feel free to raise PR and discuss on GitHub, since Slack is not quite stable in China, I can only receive the notification but can not retrieve the messages smoothly. Sorry for that.

Thanks for the heads up! I understand that Slack isn't that accessible in China, so I do recommend enabling GitHub Discussions in this repo, which will be very helpful for everyone.

Thanks :)

@Neilblaze
Copy link
Member Author

@frank-zsy Also, for this:

image

  • Change requests (Open PR)
  • Change requests reviews
  • Change request response time
  • Change request resolution duration
  • Change request age

Should I create separate metrics page (individual pages / each) for each OR create one separate metrics section and under that keep these nested, which will look something like this:

  • Change Requests
    • Open PR
    • Reviews
    • Response Time
    • Resolution Duration
    • Age

@frank-zsy
Copy link
Contributor

frank-zsy commented Jul 23, 2024

Thanks for the heads up! I understand that Slack isn't that accessible in China, so I do recommend enabling GitHub Discussions in this repo, which will be very helpful for everyone.

Of course we can enable discussion for this repo, however I don't really fond of this function because discussion events can not be collected by GitHub events API, so OpenDigger can not analyze the data in discussion right now.

Should I create separate metrics page (individual pages / each) for each OR create one separate metrics section and under that keep these nested, which will look something like this:

I think group change request and issue metrics to a category is cool and helps to organize the catalog and make it much clearer.

@Neilblaze
Copy link
Member Author

Neilblaze commented Jul 29, 2024

@frank-zsy UPDATE:

For this, I tried to keep the "Issues" section standalone and then keep two inter-sections "new" and "closed", but due to the overflow, I feel that is making the entire table ugly 😅

image

So, I'm keeping it as it is, plus I feel it makes things easier for people to perform individual search on different topics. Rest aside, if anyone wants something specific, they can use the search-bar. ^_^

Thoughts?

@Neilblaze
Copy link
Member Author

So for now, I'll start shipping out PRs for the rest of the metrics, keeping the priority on CHAOSS first, then once those are done, I can move into x-lab ones, where I'll hopefully require some help :)

@frank-zsy
Copy link
Contributor

Sure, you can ship your PR first as your understanding and we can collaborate on the PR directly. And Discussion is ready now for any further questions.

Bruce-Jay pushed a commit to Bruce-Jay/open-digger-website that referenced this pull request Aug 18, 2024
* docs: added activity_details

Signed-off-by: neilblaze <[email protected]>

* docs: add more metrics

Signed-off-by: neilblaze <[email protected]>

* doc: add latex support and modify some docs.

Signed-off-by: frank-zsy <[email protected]>

* docs: updated activity

Signed-off-by: neilblaze <[email protected]>

* merge: commit `421e67f` into new-metrics-v1 (latest)

Signed-off-by: neilblaze <[email protected]>
Co-Authored-By: Frank Zhao <[email protected]>

* docs: added more metrics (x2) & fixed typos / broken URLs

Signed-off-by: neilblaze <[email protected]>
Co-Authored-By: Frank Zhao <[email protected]>

* docs: update minor changes

Signed-off-by: frank-zsy <[email protected]>

---------

Signed-off-by: neilblaze <[email protected]>
Signed-off-by: frank-zsy <[email protected]>
Co-authored-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>
Bruce-Jay pushed a commit to Bruce-Jay/open-digger-website that referenced this pull request Sep 5, 2024
* docs: added activity_details

Signed-off-by: neilblaze <[email protected]>

* docs: add more metrics

Signed-off-by: neilblaze <[email protected]>

* doc: add latex support and modify some docs.

Signed-off-by: frank-zsy <[email protected]>

* docs: updated activity

Signed-off-by: neilblaze <[email protected]>

* merge: commit `421e67f` into new-metrics-v1 (latest)

Signed-off-by: neilblaze <[email protected]>
Co-Authored-By: Frank Zhao <[email protected]>

* docs: added more metrics (x2) & fixed typos / broken URLs

Signed-off-by: neilblaze <[email protected]>
Co-Authored-By: Frank Zhao <[email protected]>

* docs: update minor changes

Signed-off-by: frank-zsy <[email protected]>

---------

Signed-off-by: neilblaze <[email protected]>
Signed-off-by: frank-zsy <[email protected]>
Co-authored-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>
Bruce-Jay pushed a commit to Bruce-Jay/open-digger-website that referenced this pull request Sep 6, 2024
* docs: added activity_details

Signed-off-by: neilblaze <[email protected]>

* docs: add more metrics

Signed-off-by: neilblaze <[email protected]>

* doc: add latex support and modify some docs.

Signed-off-by: frank-zsy <[email protected]>

* docs: updated activity

Signed-off-by: neilblaze <[email protected]>

* merge: commit `421e67f` into new-metrics-v1 (latest)

Signed-off-by: neilblaze <[email protected]>
Co-Authored-By: Frank Zhao <[email protected]>

* docs: added more metrics (x2) & fixed typos / broken URLs

Signed-off-by: neilblaze <[email protected]>
Co-Authored-By: Frank Zhao <[email protected]>

* docs: update minor changes

Signed-off-by: frank-zsy <[email protected]>

---------

Signed-off-by: neilblaze <[email protected]>
Signed-off-by: frank-zsy <[email protected]>
Co-authored-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>
Bruce-Jay pushed a commit to Bruce-Jay/open-digger-website that referenced this pull request Sep 8, 2024
* docs: added activity_details

Signed-off-by: neilblaze <[email protected]>

* docs: add more metrics

Signed-off-by: neilblaze <[email protected]>

* doc: add latex support and modify some docs.

Signed-off-by: frank-zsy <[email protected]>

* docs: updated activity

Signed-off-by: neilblaze <[email protected]>

* merge: commit `421e67f` into new-metrics-v1 (latest)

Signed-off-by: neilblaze <[email protected]>
Co-Authored-By: Frank Zhao <[email protected]>

* docs: added more metrics (x2) & fixed typos / broken URLs

Signed-off-by: neilblaze <[email protected]>
Co-Authored-By: Frank Zhao <[email protected]>

* docs: update minor changes

Signed-off-by: frank-zsy <[email protected]>

---------

Signed-off-by: neilblaze <[email protected]>
Signed-off-by: frank-zsy <[email protected]>
Co-authored-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>
frank-zsy added a commit that referenced this pull request Sep 22, 2024
* doc: add some downstream apps in user doc (#29)

Signed-off-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>

* docs: add multiple new metrics (EN + ZH) (#28)

* docs: added activity_details

Signed-off-by: neilblaze <[email protected]>

* docs: add more metrics

Signed-off-by: neilblaze <[email protected]>

* doc: add latex support and modify some docs.

Signed-off-by: frank-zsy <[email protected]>

* docs: updated activity

Signed-off-by: neilblaze <[email protected]>

* merge: commit `421e67f` into new-metrics-v1 (latest)

Signed-off-by: neilblaze <[email protected]>
Co-Authored-By: Frank Zhao <[email protected]>

* docs: added more metrics (x2) & fixed typos / broken URLs

Signed-off-by: neilblaze <[email protected]>
Co-Authored-By: Frank Zhao <[email protected]>

* docs: update minor changes

Signed-off-by: frank-zsy <[email protected]>

---------

Signed-off-by: neilblaze <[email protected]>
Signed-off-by: frank-zsy <[email protected]>
Co-authored-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>

* feat: Initialize leaderboard page

Signed-off-by: Bruce-Jay <[email protected]>

* feat: 完成排行榜页面的初步开发

Signed-off-by: Bruce-Jay <[email protected]>

* feat: add a search input component for other pages (#35)

Signed-off-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>

* refactor: change project to typescript support (#36)

Signed-off-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>

* blog: ospp 2023 analysis (#37)

* blog: ospp 2023 analysis

Signed-off-by: frank-zsy <[email protected]>

* feat: add table row style for even row

Signed-off-by: frank-zsy <[email protected]>

---------

Signed-off-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>

* fix: fix blog edit url so it can be directly opened by editor in browser (#38)

Signed-off-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>

* feat: add a warning banner to preview deploy (#40)

Signed-off-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>

* doc: update ospp anaylsis (#41)

Signed-off-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>

* refactor: update color theme (#43)

* refactor: update color theme

Signed-off-by: frank-zsy <[email protected]>

* refactor: update redis analysis english version

Signed-off-by: frank-zsy <[email protected]>

---------

Signed-off-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>

* docs: update ospp blog

Signed-off-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>

* feat: 初步完成排行榜 banner 样式实现

Signed-off-by: Bruce-Jay <[email protected]>

* feat: 初步完成calendar的开发

Signed-off-by: Bruce-Jay <[email protected]>

* feat: 大致完成排行榜页面的开发,实现来源与仓库搜索功能。月份功能待优化。其他布局待优化

Signed-off-by: Bruce-Jay <[email protected]>

* feat: 修改图表样式,并且双击节点时图表不重新渲染

* feat: 更新样式,用户可以选择搜索建议,同时对于月份选择器进行优化

* feat: 优化用户体验,用户选择仓库后不需要点击提交按钮

* feat: 尝试删除echarts中不必要的节点

* feat: 完善加载功能,增强用户体验

* feat: 更新 Banner 样式

* refactor: add i18n, to tsx, module css

Signed-off-by: frank-zsy <[email protected]>

* refactor: use default selectInput in leaderboard and remove tailwind

Signed-off-by: frank-zsy <[email protected]>

* refactor: change page name and remove jquery

Signed-off-by: frank-zsy <[email protected]>

* refactor: try to resolve conflict

Signed-off-by: frank-zsy <[email protected]>

---------

Signed-off-by: frank-zsy <[email protected]>
Signed-off-by: Bruce-Jay <[email protected]>
Signed-off-by: neilblaze <[email protected]>
Co-authored-by: Frank Zhao <[email protected]>
Co-authored-by: Pratyay Banerjee <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants