Public Profiles
Public profiles let you show to the world how good your code is! It provides a summary of your Code Inspector projects what is your average Code Inspector score.
What projects show up on my public profile?
Your public profile contains all your public projects. Private projects are NOT used for the public profile page.
How to enable your public profile?
Public profil
How to access your public profile?
To access your public profile, use the URL in your user preferences.
The URL looks like this
https://frontend.code-inspector.com/public/user/<usertype>/<username>
You can check out this public profile for example.
Where usertype
is the type of user (github
, gitlab
or bitbucket
)
and username
is the identifier of the user on this platform.
The static content is a static HTML version that is great for indexing with a search engine. The dynamic version is an implementation of the public profile on our frontend and is less SEO friendly.
What all these numbers mean?
At the top left, the profile shows user information such as location, link to the profile on GitHub/GitLab/Bitbucket.
Top Row
The top row is a summary of the quality of all projects owned by this user.
The quality score is the average quality score for all projects owned by this user.
On the right of this quality score, there is the breakdown of the violation distribution for all projects.
Project-specific information
For each project, the page shows the quality score of the project as well as the violations distribution within this project.
The information for each project does not contain all the data collected by Code Inspector. You can use the main project dashboard to get more metrics and get more insights about each projects.
How to add your Code Inspector public profile on your GitHub profile?
GitHub has a public profile features where you can show and highlights details about your career and coding statistics. Code Inspector gives the opportunity to surface your code quality metrics directly on your GitHub profile.
On your README.md
file, inserts a code snippet like this (replace <username>
by your GitHub username).
Make sure your public profile is enabled on Code Inspector in your user preferences.
<a href="https://frontend.code-inspector.com/public/user/github/<username>">
<img src="https://code-inspector.com/public/badge/user/github/<username>" alt="code inspector badge" />
</a>
The result looks like the following picture, the Code Inspector badge shows details about your personal coding statistics. It also links to your personal public profile on Code Inspector.