openml / openml-python

OpenML's Python API for a World of Data and More 💫
http://openml.github.io/openml-python/
Other
284 stars 144 forks source link

List contributors for the different releases #685

Open mfeurer opened 5 years ago

mfeurer commented 5 years ago

Probably like for Auto-sklearn or scikit-learn. I have a command in the Auto-sklearn repo which can retrieve all contributors between two commits.

https://github.com/automl/auto-sklearn/blob/master/doc/releases.rst (edit by @PGijsbers from edit link to blob link)

mfeurer commented 4 years ago

@PGijsbers @HeidiSeibold is this related to #959

PGijsbers commented 4 years ago

Could you maybe add a reference to the script?

mfeurer commented 4 years ago

It's in the comment at the top: https://raw.githubusercontent.com/automl/auto-sklearn/master/doc/releases.rst

PGijsbers commented 4 years ago

Doh, I missed the fact that it is a rst file. Github rendered it for me which means the rst specific note was not displayed:

..
    The following command allows to retrieve all commiters since a specified
    commit. From http://stackoverflow.com/questions/6482436/list-of-authors-in-git-since-a-given-commit
    git log 2e29eba.. --format="%aN <%aE>" --reverse | perl -e 'my %dedupe; while (<STDIN>) { print unless $dedupe{$_}++}'
HeidiSeibold commented 4 years ago

959 is related, but it's maybe a bit of different idea behind it. Happy to discuss

mfeurer commented 4 years ago

So the idea of the all contributors bot is to have all contributors to the project in the readme I guess? The difference would then be that it's harder to get to front there because a lot of folks might have contributed more already? In contrast, listing them in the release notes gives them immediate attention. Is that summarized correctly?

PGijsbers commented 4 years ago

I think they supplement each other. Adding contributors to the release notes directly acknowledges active contributors. The all contributor bot acknowledges gives a better overview of the contribution history (at a glance) and shows what aspects of the project each contributor is/was involved with (documentation, code, reviews, ...). Note that e.g. reviewers would also not be credited by the release notes script.