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

Update Contributors List and Badge #394

Merged
merged 7 commits into from
Jan 19, 2025
Merged

Update Contributors List and Badge #394

merged 7 commits into from
Jan 19, 2025

Conversation

Spinachboul
Copy link
Contributor

Fixes #391

  • Updated the contributors list with new additions.
  • Included individual contribution counts for each contributor.
  • Added the all-contributors badge for better tracking of contributions

Copy link
Contributor

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Really great!

  • can you remove the bots, kindly? Like dependabot.
  • could you describe how you did this, e.g., executing sth on command line?

What would be very useful is a CI step to automate the update, like in sktime. Though that does not need to be done in this PR.

@Spinachboul
Copy link
Contributor Author

@fkiraly
Thanks for the feedback
I used the command

curl https://api.github.com/repos/sktime/skbase/contributors?per_page=100 > contributors.json

to generate a list of all the contributors

Then I used the script to update all the contributors in .all-contributorsrc

import json
# Load contributors from the GitHub API response
with open('contributors.json', 'r') as file:
    contributors = json.load(file)

with open('.all-contributorsrc', 'r') as file:
    all_contributors_config = json.load(file)

existing_logins = {contributor["login"] for contributor in all_contributors_config.get("contributors", [])}
for contributor in contributors:
    login = contributor["login"]
    if login not in existing_logins:
        all_contributors_config["contributors"].append({
            "login": login,
            "name": login,
            "avatar_url": contributor["avatar_url"],
            "contributions": ["code"]  
        })
with open('.all-contributorsrc', 'w') as file:
    json.dump(all_contributors_config, file, indent=2)

print("All contributors have been added to .all-contributorsrc!")

And then I simply updated the CONTRIBUTORS.md file by taking the framework reference from sktime

@Spinachboul
Copy link
Contributor Author

Thanks! Really great!

  • can you remove the bots, kindly? Like dependabot.
  • could you describe how you did this, e.g., executing sth on command line?

What would be very useful is a CI step to automate the update, like in sktime. Though that does not need to be done in this PR.

Yes! I would need some guidance on doing that. Though I'd love implementing that here

@Spinachboul Spinachboul requested a review from fkiraly January 17, 2025 15:40
@fkiraly fkiraly added the documentation Documentation & tutorials label Jan 19, 2025
Copy link
Contributor

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

I made some minor changes:

  • reverted diacritic replacements - probably accidental?
  • removed the bots - these are not intelligent AI, but simply automation bots
  • I replaced the new paragraph in the README with a link to the contributors page. Your proposed change had a couple duplicated paragraphs, and a fixed list which would not update with new contributors.
    • I think this is a good idea, but we should link only when we have figured out how to keep the list updated, and using the emoji key.

Copy link

codecov bot commented Jan 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.77%. Comparing base (306958d) to head (4acc080).
Report is 97 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #394      +/-   ##
==========================================
+ 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.

@fkiraly fkiraly merged commit dfe2656 into sktime:main Jan 19, 2025
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation & tutorials
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Contributors page is broken
2 participants