Golang-tutorial icon indicating copy to clipboard operation
Golang-tutorial copied to clipboard

🚀 Feature: Create contributor section in Readme and automate process

Open Yashsharma1911 opened this issue 1 year ago • 31 comments

📜 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?

  • [X] I checked and didn't find similar issue

🔖 Have you read the Code of Conduct?

  • [X] Yes, I have read Code of Conduct.

Yashsharma1911 avatar Jul 02 '23 19:07 Yashsharma1911

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

Yashsharma1911 avatar Jul 02 '23 19:07 Yashsharma1911

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

This seems interesting I'll look into it

CulturalProfessor avatar Jul 02 '23 19:07 CulturalProfessor

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

CulturalProfessor avatar Jul 03 '23 13:07 CulturalProfessor

@CulturalProfessor @SoumyadeepOSD are you working on it?

Harsh4902 avatar Jul 03 '23 16:07 Harsh4902

@CulturalProfessor @SoumyadeepOSD are you working on it?

Yeah

CulturalProfessor avatar Jul 03 '23 16:07 CulturalProfessor

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

Harsh4902 avatar Jul 03 '23 16:07 Harsh4902

@CulturalProfessor @SoumyadeepOSD are you working on it?

Yeah

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

SoumyadeepOSD avatar Jul 03 '23 17:07 SoumyadeepOSD

@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

Yashsharma1911 avatar Jul 03 '23 18:07 Yashsharma1911

@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 avatar Jul 03 '23 18:07 CulturalProfessor

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.

CulturalProfessor avatar Jul 03 '23 19:07 CulturalProfessor

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?

SagarSingh2003 avatar Jul 04 '23 10:07 SagarSingh2003

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

CulturalProfessor avatar Jul 05 '23 16:07 CulturalProfessor

Thanks for detail explanation @CulturalProfessor I'm installing it

Yashsharma1911 avatar Jul 05 '23 16:07 Yashsharma1911

Thanks for detail explanation @CulturalProfessor I'm installing it

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

SagarSingh2003 avatar Jul 05 '23 16:07 SagarSingh2003

@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

Yashsharma1911 avatar Jul 05 '23 16:07 Yashsharma1911

@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

SagarSingh2003 avatar Jul 05 '23 16:07 SagarSingh2003

@all-contributors please add @SagarSingh2003 for doc

Yashsharma1911 avatar Jul 05 '23 17:07 Yashsharma1911

@Yashsharma1911

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

allcontributors[bot] avatar Jul 05 '23 17:07 allcontributors[bot]

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 avatar Jul 05 '23 17:07 Yashsharma1911

@all-contributors please add @Harsh4902 for code

Yashsharma1911 avatar Jul 05 '23 17:07 Yashsharma1911

@Yashsharma1911

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

allcontributors[bot] avatar Jul 05 '23 17:07 allcontributors[bot]

@all-contributors please add @CulturalProfessor for doc

Yashsharma1911 avatar Jul 05 '23 17:07 Yashsharma1911

@Yashsharma1911

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

allcontributors[bot] avatar Jul 05 '23 17:07 allcontributors[bot]

@all-contributors please add @SoumyadeepOSD for doc

Yashsharma1911 avatar Jul 05 '23 17:07 Yashsharma1911

@Yashsharma1911

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

allcontributors[bot] avatar Jul 05 '23 17:07 allcontributors[bot]

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

Yashsharma1911 avatar Jul 05 '23 17:07 Yashsharma1911

@Yashsharma1911

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

allcontributors[bot] avatar Jul 05 '23 17:07 allcontributors[bot]

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

Yashsharma1911 avatar Jul 05 '23 17:07 Yashsharma1911

@Yashsharma1911

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

@Harsh4902 already contributed before to code

@SoumyadeepOSD already contributed before to doc

allcontributors[bot] avatar Jul 05 '23 17:07 allcontributors[bot]

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.

CulturalProfessor avatar Jul 05 '23 17:07 CulturalProfessor