ykdojo / OpenStream

OpenStream is an open-source project for creating a free tool that records screen and webcam footage simultaneously into separate files. It's designed for content creators and developed collaboratively through our community on Discord.
MIT License
105 stars 23 forks source link

Add all contributors GitHub Action #6

Closed CBID2 closed 4 months ago

CBID2 commented 5 months ago

I have seen other projects use this bot in their Contributing.MD file and thought this would be a good thing to put too.

ykdojo commented 5 months ago

What does it do exactly?

CBID2 commented 5 months ago

What does it do exactly?

It shows a list of people who have contributed to your project.

ykdojo commented 5 months ago

I'm not sure if that's necessary. We kind of already have that on GitHub, and we can manually add most active contributors later.

ykdojo commented 5 months ago

Since I'm still not sure if/why this is necessary, I'll close this issue if there's no objective.

CBID2 commented 5 months ago

Since I'm still not sure if/why this is necessary, I'll close this issue if there's no objective.

It'll make it easier you to add the contributors to your ReadMe @ykdojo. From what I've heard from other maintainers, it's a lot of work to do it manually.

ykdojo commented 5 months ago

Hmm interesting. I'm not sure how helpful it is though. We already have this: https://github.com/ykdojo/OpenStream/graphs/contributors

CBID2 commented 5 months ago

Hmm interesting. I'm not sure how helpful it is though. We already have this: https://github.com/ykdojo/OpenStream/graphs/contributors The GitHub version mostly focuses on the contributors’ commit history, which gives the impression that only code contributions are accepted. The GitHub action on the other hand, specifies the ways other people have contributed and hyperlinks their social profiles. This can encourage people from all backgrounds to come and contribute to the project as well as give them an opportunity to see the work they do beyond GitHub.

ykdojo commented 5 months ago

I see. I still think it's better to do it manually. That way, we can have people send a PR adding their name if they feel like they've made a significant contribution especially if it's outside of GitHub?

CBID2 commented 5 months ago

I see. I still think it's better to do it manually. That way, we can have people send a PR adding their name if they feel like they've made a significant contribution especially if it's outside of GitHub?

I don't know @ykdojo. From what I've seen, contributors do tend to like the acknowledgement no matter how or small the contribution is. Also, having them add it manually adds an extra layer of work, which can be tiring, especially if a contributor has just finished making a major PR. I really think we should try this GitHub Action. It's been effective in other projects I've contributed to.

ykdojo commented 5 months ago

I see. It might be worth trying then. It's free?

CBID2 commented 5 months ago

I see. It might be worth trying then. It's free?

Great! :) Yes it is free @ykdojo

ykdojo commented 5 months ago

I've thought about this, and I realized what'd be helpful is having the contributor's name, Discord name, and social media handle if they want to add it.

I feel like the best way to do this is simply by asking them to add themselves to a table of contributors.

Thoughts?

CBID2 commented 5 months ago

I've thought about this, and I realized what'd be helpful is having the contributor's name, Discord name, and social media handle if they want to add it.

I feel like the best way to do this is simply by asking them to add themselves to a table of contributors.

Thoughts?

Hi @ykdojo. Ehh, I still think that the GitHub Action would be best.

ykdojo commented 5 months ago

Can you explain why and how what I described can be achieved with it?

CBID2 commented 5 months ago

Can you explain why and how what I described can be achieved with it?

@ykdojo, it'll allow to focus more on maintaining the project. Also, it'll automatically create the table for you,thus gaining an increase in productivity.

ykdojo commented 5 months ago

But we'll need to have the contributors add other info like their Discord and social media handles on their own anyway?

CBID2 commented 5 months ago

But we'll need to have the contributors add other info like their Discord and social media handles on their own anyway? @ykdojo, it'll hyperlink their GitHub profile, so contributors don't need to add their Discord or social media

ykdojo commented 5 months ago

This is what I said earlier:

I've thought about this, and I realized what'd be helpful is having the contributor's name, Discord name, and social media handle if they want to add it.

I feel like the best way to do this is simply by asking them to add themselves to a table of contributors.

CBID2 commented 5 months ago

This is what I said earlier:

I've thought about this, and I realized what'd be helpful is having the contributor's name, Discord name, and social media handle if they want to add it.

I feel like the best way to do this is simply by asking them to add themselves to a table of contributors.

Ok @ykdojo

ykdojo commented 4 months ago

33