Add CI for updating contributors

[Spinachboul]

Reference to discussion in PR #394

Adds the update_contributors.yml CI which is same as in sktime

[fkiraly]

Thanks!

I updated from main - including the reverted changes from the README.

It would be nice to have an updating section in the readme with profile pictures, but this is not blocking.

I would also suggest to show emoji keys primarily, since they also acknowledge non-code contributions. (Count of commits is also misleading a bit, since part of the code base was copied over from sktime, so the initial contributions to these base classes are not tracked in the commit history. Early contributions are also inflated, as PR commit practice was not well-established then.)

[Spinachboul]

Thanks!

I updated from main - including the reverted changes from the README.

It would be nice to have an updating section in the readme with profile pictures, but this is not blocking.

I would also suggest to show emoji keys primarily, since they also acknowledge non-code contributions. (Count of commits is also misleading a bit, since part of the code base was copied over from sktime, so the initial contributions to these base classes are not tracked in the commit history. Early contributions are also inflated, as PR commit practice was not well-established then.)

So instead of quoating the number of commits , I need to display then contribution type in the form of emojis? Am I going right on this??
Though I did add the pictures of the contributors in the readme section

[Spinachboul]

Can I add the pictures like this? After the emoji-key

[fkiraly]

The pictures are nice, is this automtaed?

I think there is a script somewhere that generates the table of contributors, as in sktime - like this https://www.sktime.net/en/latest/about/contributors.html

[Spinachboul]

@fkiraly
You mean maybe in here, we can add the contributors pictures like in this link?
https://github.com/sktime/sktime/blob/main/CONTRIBUTORS.md

[fkiraly]

@fkiraly You mean maybe in here, we can add the contributors pictures like in this link? https://github.com/sktime/sktime/blob/main/CONTRIBUTORS.md

yes - is there not an automated script doing that, somewhere?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.77%. Comparing base (306958d) to head (51e1bb9).
Report is 98 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #395      +/-   ##
==========================================
+ Coverage   85.07%   85.77%   +0.70%     
==========================================
  Files          45       48       +3     
  Lines        3015     3311     +296     
==========================================
+ Hits         2565     2840     +275     
- Misses        450      471      +21     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Spinachboul]

@fkiraly You mean maybe in here, we can add the contributors pictures like in this link? https://github.com/sktime/sktime/blob/main/CONTRIBUTORS.md

yes - is there not an automated script doing that, somewhere?

I think this is the script that automates the file contributors.md

npm install -g all-contributors-cli

all-contributors add <github-username> <contribution-types>

[Spinachboul]

@fkiraly
Also sktime has this workflow called update_contributors.yml which is missing in skbase
We need to include that also to automate the whole thing
I have included that in this PR

[fkiraly]

is this ready for review, or still a work in progress?

If ready, could you summarize how the automation functions?

[Spinachboul]

is this ready for review, or still a work in progress?

If ready, could you summarize how the automation functions?

Yes! It is ready for merge
So there are primarily 2 approaches for automation

• Github Actions
  The workflow update_contributors.yml (also included in this PR) runs automatically commands like npx all-contributors generate whenever a trigger event occurs

• A manual task using the command @all-contributors please add @username for code
  which is to instruct the All Contributors Bot

[allcontributors]

@Spinachboul

Could not find the user username on github.

[Spinachboul]

@Spinachboul

Could not find the user username on github.

@fkiraly like this , it automatically responds to the instruction

[fkiraly]

Nice! One question: why does it respond to your instruction, given that you do not have write access to this repo?

[Spinachboul]

Nice! One question: why does it respond to your instruction, given that you do not have write access to this repo?

I simply guess when we tag the bot, it responds.
I am not sure why that is happening

[fkiraly]

Alright, let me try:

@all-contributors please add @Spinachboul for code

[allcontributors]

@fkiraly

I've put up a pull request to add @Spinachboul! 🎉