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

feat(plugins/notable): add indepth mode #635

Merged
merged 7 commits into from
Nov 4, 2021
Merged

Conversation

lowlighter
Copy link
Owner

@lowlighter lowlighter commented Oct 29, 2021

Closes #615

  • fetch repo nb of commits
  • fetch user commits of said repo
  • check if user is maintainer
  • sorting => bugged
  • templates => to improve

Current preview:
image

Questions:

  • how to display "earned stars" ? or should we just display the total amount in a stats field, like an overall contribution score ?
  • tried to keep same color scheme as achievement, but this kind of look chaotic there, maybe just keep 2 thresholds ? (maintainer + more than X% ?)
  • should probably display <1% as "<1%" instead of "1%"
  • need to find a good threshold, contributing to open source projects is hard so we should find a balance with "active contributor" and "occasional contributor"

@jayvdb
Copy link
Contributor

jayvdb commented Oct 29, 2021

how to display "earned stars"

Random idea: "About Pips" on https://community.synopsys.com/s/article/Black-Duck-Open-Hub-About-Badges explains a nice UX for multi-level badges. The pips might appear under the repo name for this plugin, probably instead of a %.

should probably display <1% as "<1%" instead of "1%"

IMO showing 1% for anything lower than 1% is the only bug here. The rest can be improved over time, but it should round down, not up, at least for small percentages.

Possibly 1c for one commit, etc ?

Possibly have another filter mechanism for removing contributions with a low number of commits, as another way to remove any 1% / 0% from the output. This would exclude the "really important contribution which is only a single commit", which can be quite meaningful for early OSS contributors, but that could be address in other ways later, such as checking the size of the commit before excluding it.

tried to keep same color scheme as achievement, but this kind of look chaotic there ..

I quite like the multi-level approach. It will take a bit of effort for readers to click, but I would put it near achievements to help that cognitive leap, as the two are closely tied together.

@lowlighter
Copy link
Owner Author

how to display "earned stars"

Finally went with something similar to achievements / pagespeed plugins, where the gauge reflects the percentage of commits authored while the center text indicates its number.
In case "additional stats" ever gets added, a mini "commits octicon" is displayed on the bottom right of the badge

Possibly have another filter mechanism for removing contributions with a low number of commits, as another way to remove any 1% / 0% from the output.

This will be done in another iteration (#651)


Here's the initial iteration for this feature:

@lowlighter lowlighter marked this pull request as ready for review November 4, 2021 03:40
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improved notable contributions scoring system
2 participants