WARNING: This project
isn't actively maintained anymore.
Table of Contents
What we are building
Example: https://ghuser.io/AurelienLourot
We love the default GitHub profiles and we want to enhance them:
- The GitHub profiles aren't clearly showing all the repos you have contributed to since you joined
GitHub. We are showing them all, even those you don't own and those owned by organizations
you're not in.1 - The GitHub profiles are listing all the repos you own but they sort them only by age of the
latest commit. We prefer to sort repos by a combination of how much you
have contributed to them, their size, how popular they are, etc. For each user we want to see
first the latest greatest repos they have most contributed to. - On GitHub only repos earn stars. We push it one step further by having users earn stars:
You earn stars when you contribute to a repo.
We add all these earned stars and show how many you've earned in total. - The GitHub profiles don't clearly show how big your contribution to a repo was, when you don't own
it. Maybe you wrote 5%. Maybe 90%. We make it clear. - GitHub detects programming languages. We also want to know about
technologies/frameworks, e.g. "react", "docker", etc. - The GitHub profiles allow filtering your repos by programming language. We will allow filtering
by technologies/frameworks as well. - The GitHub profiles can be tweaked by clicking around. We allow them to be
tweaked programmatically. - On GitHub only users and organizations have avatars. We bring
avatars to repos.
Our enhanced profiles are accessible at https://ghuser.io/<github-username>, e.g.
ghuser.io/AurelienLourot.
1 We achieve this by using github-contribs.
Contributing
To the web app's implementation
- Fork this project.
- Make some changes to the web app.
- Validate your changes by running the app locally.
- Create a pull request :)
To the documentation
- Fork this project.
- Make some changes to the markdown files.
- Validate your changes by running
./build.sh. - Create a pull request :)
Contributors
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors
specification. Contributions of any kind welcome!
NOTE: if you should be on the list of contributors but we forgot you, don't be shy and let us
know!
FAQ
Is my profile static or dynamic?
For now it's static and the data2 is refreshed at least
once per day. If you scroll down to the
bottom of your profile you can see how old the data is:
2 All the data about you and your contributions.
Some of my repos are not showing up on my profile, why?
Did you give them a star? We don't display repos with no stars at all. We think that if even you
haven't given them a star, then you probably aren't proud of them (yet).
Does ghuser.io intend to compete with the default GitHub profiles?
No, in fact we'd love GitHub to copy ghuser.io or to even do better, so that this project can die.
How are the organizations sorted in the Contributed to section?
For now it's kind of random. See
#142 for more
details.