mkdocs-git-authors-plugin icon indicating copy to clipboard operation
mkdocs-git-authors-plugin copied to clipboard

sort the authors by contribution and eliminate low-contribution authors

Open fundthmcalculus opened this issue 3 years ago • 3 comments

  1. It is helpful to eliminate authors with a very low contribution percentage.
  2. It is helpful to sort authors by contribution percentage without showing the percentage

As a result, the following config options are added:

  1. sort_authors_by - defaults to name, can also be contribution
  2. authorship_threshold_percent - defaults to 0 for backwards compatibility. Sets the lower bound for inclusion as an author.

fundthmcalculus avatar Apr 06 '22 20:04 fundthmcalculus

Interesting & valuable update, thanks!

I will not be able to get around to reviewing it until somewhere next week. hopefully you're not in a hurry ;)

timvink avatar Apr 08 '22 08:04 timvink

Interesting & valuable update, thanks!

I will not be able to get around to reviewing it until somewhere next week. hopefully you're not in a hurry ;)

No problem, we're currently doing some testing on it with our company docs site: https://docs-v2.trinsic.id/ from the fork.

  • I've also got an alternative idea for the pruning (show only top N authors). That way, if you have 3 contributors at 32% each and 1 at 4%, you can give equal credit to the majors and eliminate the minor.
  • Maybe add an option for et al and a hyperlink to expand the full author list?

fundthmcalculus avatar Apr 08 '22 14:04 fundthmcalculus

I can take care of all changes, will let you know when I get the PR updated.

fundthmcalculus avatar Apr 19 '22 20:04 fundthmcalculus

Hi @fundthmcalculus , I see this PR is stale. Are you able to pick up the last couple of changes? I'd like to make a new release with your changes included!

timvink avatar Oct 30 '22 18:10 timvink

Merged! I will take care of the changes & make a release. Thanks for all the work on this one, will ping you once the release is there.

timvink avatar Nov 02 '22 19:11 timvink