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

Api endpoint to see level info #2257

Open
CaedenPH opened this issue Nov 6, 2022 · 3 comments
Open

Api endpoint to see level info #2257

CaedenPH opened this issue Nov 6, 2022 · 3 comments
Labels
enhancement New feature or request. ranks Feature, Bug fix, improvement related to ranking system.

Comments

@CaedenPH
Copy link
Contributor

CaedenPH commented Nov 6, 2022

Is your feature request related to a problem? Please describe.

I don’t know how close to being level S…
Is it commits, pull requests, issues or stars that I don’t have enough of?

Describe the solution you'd like

This endpoint could show how close you were to the next level, display information about how much each category (issues, prs, commits, stars, contributed to, etc..) impacts your overall stats card

Describe alternatives you've considered

Running tests on the source code but this is pretty ardous and difficult

Additional context

This api would give information such as

  • your rank
  • your overall score
  • how many points are required for the next level
  • how many commits/issues/stars are required for the next level
  • information about how much each category impacts your overall score (perhaps something like issues 30%, commits 50%, pull requests 20%)
  • as much information as possible regarding this
    Perhaps it could be a json endpoint instead of visual
@CaedenPH CaedenPH added the enhancement New feature or request. label Nov 6, 2022
@rickstaa rickstaa added the ranks Feature, Bug fix, improvement related to ranking system. label Nov 20, 2022
@rickstaa
Copy link
Collaborator

@CaedenPH Thanks for your feature request. I agree that manually running the https://github.com/anuraghazra/github-readme-stats/blob/master/src/calculateRank.js script to find out how close you are to a rank is tedious 😅. Therefore, I think providing an interface allows users to quickly see how their rank changes if they get more commits, contribs, issues, stars, pr, followers and repositories. I think the best way to add such a GUI is in the website when it is completed (see #1761).

Since there is a lot of discussion about changing the rank system (see #455), I would not create a PR right now but wait till the rank system is improved, and the website is released.

Related to ##2070.

@anuraghazra
Copy link
Owner

I don’t know how close to being level S…

These are all good options, but please don't use the Ranking algorithm as a roadmap or your "career progression" metric. It's purely for gamification and fun. So don't take it too seriously.

@rickstaa
Copy link
Collaborator

rickstaa commented Jul 3, 2023

I don’t know how close to being level S…

These are all good options, but please don't use the Ranking algorithm as a roadmap or your "career progression" metric. It's purely for gamification and fun. So don't take it too seriously.

🦄🎊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request. ranks Feature, Bug fix, improvement related to ranking system.
Projects
None yet
Development

No branches or pull requests

3 participants