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

[CI/CD] Setup All Contributors Bot #29

Open
RNKuhns opened this issue Jul 22, 2022 · 9 comments
Open

[CI/CD] Setup All Contributors Bot #29

RNKuhns opened this issue Jul 22, 2022 · 9 comments
Labels
documentation Documentation & tutorials maintenance Continuous integration, unit testing & package distribution
Milestone

Comments

@RNKuhns
Copy link
Contributor

RNKuhns commented Jul 22, 2022

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is.

Let's setup the All Contributors bot.

@RNKuhns RNKuhns added maintenance Continuous integration, unit testing & package distribution documentation Documentation & tutorials labels Jul 22, 2022
@RNKuhns RNKuhns added this to the Release 0.1.0 milestone Jul 22, 2022
@achieveordie
Copy link
Contributor

Hey Ryan, I've been trying to automate updating CONTRIBUTORS.md in sktime as well. I think having a workflow file will be better than having a bot since in the case of the bot we'd have to manually ask it to add the contributors anyways - I figured why not automate it completely?

It's still being tested and probably has some problems but let me know what your thoughts on it are. We could do the same thing for skbase as well.

@RNKuhns
Copy link
Contributor Author

RNKuhns commented Nov 29, 2022

@achieveordie I like the idea of the fully automated workflow. If your willing to open the PR here, it would be great. I'll check out the PR in sktime as well.

@achieveordie
Copy link
Contributor

I'll add it here as soon as it is accepted/merged in sktime.

@RNKuhns RNKuhns changed the title Setup All Contributors Bot [CI/CD] Setup All Contributors Bot Jan 8, 2023
@RNKuhns
Copy link
Contributor Author

RNKuhns commented Jan 26, 2023

@achieveordie what did the status of this end up being on sktime?

@achieveordie
Copy link
Contributor

@RNKuhns There are a few important things we need to discuss from here. I believe we're almost at the stage where the workflow file can be added here as well. I'm looking forward to your opinion and input.

@RNKuhns
Copy link
Contributor Author

RNKuhns commented Feb 18, 2023

@achieveordie I think I'm fine with the caveats described in sktime/sktime#4103. I know you were testing things there. If it looks like that worked. Can you open a PR that adds the functionality here? Also, let's add something in the docs that clearly describes what a new contributor would have to do.

Just ping me when you have a chance to make the PR and I'll review it. Also feel free to bounce any ideas off of me about the doc portion.

@achieveordie
Copy link
Contributor

that clearly describes what a new contributor would have to do.

I suppose we let them know in our repo's README.md that we follow all-contributors specification followed by a line that asks them to update .all-contributorsrc to add themselves as contributors. I don't think we need a CONTRIBUTING.md file yet, what are your opinions on it?

@fkiraly
Copy link
Contributor

fkiraly commented Feb 23, 2023

contributing.md is the "canonical location" that points people to how to contribute.
Some repository inspection interfaces expect it, and users will expect it, so instead of removing it, it should point to the "how to contribute" section of the docs, imo.

@RNKuhns
Copy link
Contributor Author

RNKuhns commented Mar 1, 2023

@achieveordie sorry for delay in responding.

I’m a fan of building all the plumbing I know I’ll want from the start. So it would be nice to to have contributors.md.

But I am also up for a potential simpler automation strategy. Couldn’t we just have GH action that runs at specified interval (daily). That updates contributors.md with any changes based on underlying contributors file? Then opens PR?

it would be awesome for broader OSS community to have the fuller integration you have been pursuing (help to many projects). But if there is something g that keeps it pretty up to date I think that also helps everyone (it is easy to forget to update contributors).

@RNKuhns RNKuhns modified the milestones: Release 0.4.0, Release 0.5.0 Mar 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation & tutorials maintenance Continuous integration, unit testing & package distribution
Projects
None yet
Development

No branches or pull requests

3 participants