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

🚀 Feature: Create contributor section in Readme and automate process #19

Open
2 tasks done
Yashsharma1911 opened this issue Jul 2, 2023 · 31 comments
Open
2 tasks done
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Yashsharma1911
Copy link
Owner

📜 Feature Description

Currently, we don't have a section to share profiles of contributors in readme, Let's add then. This issue required installation of bot so that we can automate this process.

Give suggestions for some bots, here is what I found github.com/all-contributors

🎤 Pitch

No response

👀 Have you spent some time to check if this issue has been raised before?

  • I checked and didn't find similar issue

🔖 Have you read the Code of Conduct?

  • Yes, I have read Code of Conduct.
@Yashsharma1911 Yashsharma1911 added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 2, 2023
@Yashsharma1911 Yashsharma1911 changed the title 🚀 Feature: Create contributor section and automate process 🚀 Feature: Create contributor section in Readme and automate process Jul 2, 2023
@Yashsharma1911
Copy link
Owner Author

@SagarSingh2003 @CulturalProfessor @Harsh4902 maybe you guys can help here?

@CulturalProfessor
Copy link
Collaborator

@SagarSingh2003 @CulturalProfessor @Harsh4902 maybe you guys can help here?

This seems interesting I'll look into it

@CulturalProfessor
Copy link
Collaborator

hey @Yashsharma1911 we'll have to install all-contributors bot first right?

@Harsh4902
Copy link
Collaborator

@CulturalProfessor @SoumyadeepOSD are you working on it?

@CulturalProfessor
Copy link
Collaborator

@CulturalProfessor @SoumyadeepOSD are you working on it?

Yeah

@Harsh4902
Copy link
Collaborator

hey @Yashsharma1911 we'll have to install all-contributors bot first right?
Yes. Add it using github actions

@SoumyadeepOSD
Copy link
Contributor

@CulturalProfessor @SoumyadeepOSD are you working on it?

Yeah

Okay you work on this issue. I move to another one

@Yashsharma1911
Copy link
Owner Author

@CulturalProfessor Yes please do look at what things are needed like a token or something then propose your method here so that I can provide credentials to you if needed, if not propose here how we are going to implement so that others can also review

@CulturalProfessor
Copy link
Collaborator

@CulturalProfessor Yes please do look at what things are needed like a token or something then propose your method here so that I can provide credentials to you if needed, if not propose here how we are going to implement so that others can also review

Ok I'll update with a approach

@CulturalProfessor
Copy link
Collaborator

CulturalProfessor commented Jul 3, 2023

https://allcontributors.org/docs/en/bot/installation
Hey @Yashsharma1911 we'll have to install this bot first into our repo and then make changes to our Readme.md ,after that we make a comment on Issue or Pull Request like "@all-contributors please add @username for contributions" and it will open up a pr to add contributor's name to Readme.md.

@SagarSingh2003
Copy link
Collaborator

https://allcontributors.org/docs/en/bot/installation Hey @Yashsharma1911 we'll have to install this bot first into our repo and then make changes to our Readme.md ,after that we make a comment on Issue or Pull Request like @all-contributors please add @ for and it will open up a pr to add contributor's name to Readme.md.

Thanks for sharing this @CulturalProfessor can I help with this?

@CulturalProfessor
Copy link
Collaborator

First we'll have to install the bot so I guess only @Yashsharma1911 has permission to do it in repo.

@Yashsharma1911
Copy link
Owner Author

Thanks for detail explanation @CulturalProfessor I'm installing it

@SagarSingh2003
Copy link
Collaborator

Thanks for detail explanation @CulturalProfessor I'm installing it

I'll be happy to help if you need any @Yashsharma1911 @CulturalProfessor

@Yashsharma1911
Copy link
Owner Author

@SagarSingh2003 thanks for raising your hand then @CulturalProfessor I have installed the bot read this page form all-contributors https://allcontributors.org/docs/en/bot/configuration for bot configuration in repo and after you create a PR @SagarSingh2003 please review it

@SagarSingh2003
Copy link
Collaborator

@SagarSingh2003 thanks for raising your hand then @CulturalProfessor I have installed the bot read this page form all-contributors https://allcontributors.org/docs/en/bot/configuration for bot configuration in repo and after you create a PR @SagarSingh2003 please review it

will do no problem

@Yashsharma1911
Copy link
Owner Author

@all-contributors please add @SagarSingh2003 for doc

@allcontributors
Copy link
Contributor

@Yashsharma1911

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

@Yashsharma1911
Copy link
Owner Author

well it's working fine now still @CulturalProfessor please look how what needs to be place in CONTRIBUTION.md file so that contributors can add themselves in contributors section

@Yashsharma1911
Copy link
Owner Author

@all-contributors please add @Harsh4902 for code

@allcontributors
Copy link
Contributor

@Yashsharma1911

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

@Yashsharma1911
Copy link
Owner Author

@all-contributors please add @CulturalProfessor for doc

@allcontributors
Copy link
Contributor

@Yashsharma1911

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

@Yashsharma1911
Copy link
Owner Author

@all-contributors please add @SoumyadeepOSD for doc

@allcontributors
Copy link
Contributor

@Yashsharma1911

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

@Yashsharma1911
Copy link
Owner Author

@all-contributors
please add @Yashsharma1911 for code.
please add @Yashsharma1911 for doc.
please add @Yashsharma1911 for review.

@allcontributors
Copy link
Contributor

@Yashsharma1911

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

@Yashsharma1911
Copy link
Owner Author

@all-contributors
please add @CulturalProfessor for review.
please add @Harsh4902 for code.
please add @SoumyadeepOSD for doc.

@allcontributors
Copy link
Contributor

@Yashsharma1911

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

@Harsh4902 already contributed before to code

@SoumyadeepOSD already contributed before to doc

@CulturalProfessor
Copy link
Collaborator

well it's working fine now still @CulturalProfessor please look how what needs to be place in CONTRIBUTION.md file so that contributors can add themselves in contributors section

I think bot will just put up a pr if any contributor calls it , we should let it be now with a manual check before merging as auto merging could later lead to spam contributors also.

@Yashsharma1911
Copy link
Owner Author

well it's working fine now still @CulturalProfessor please look how what needs to be place in CONTRIBUTION.md file so that contributors can add themselves in contributors section

I think bot will just put up a pr if any contributor calls it , we should let it be now with a manual check before merging as auto merging could later lead to spam contributors also.

good point

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants