Automatically update the contributors in readme

V2dha / alphadoc

Automatic docstring generator that supports and generates a number of specified and widely used docstring style conventions for documentation in Python.

https://pypi.org/project/alphadoc/

MIT License

6 stars 4 forks source link

Automatically update the contributors in readme #23

Closed V2dha closed 3 years ago

V2dha commented 3 years ago

Is there a way to automatically update the contributors in the readme with emoji associated with the type of contribution for instance by looking at the label like documentation or enhancement.

Dhriti-Roy commented 3 years ago

I want to start working on it. Kindly assign this to me.

V2dha commented 3 years ago

Thanks @Dhriti-Roy. Can you tell me how you are planning to do that?

tusharnankani commented 3 years ago

Hi @V2dha

I would like to work on this.

There are 2 approaches.

Statically generated.

These will be static and won't link the individual contributor.
1. Dynamically generated
These are generated dynamically and look like this.

This process is quite cumbersome as you have to call the bot every time you get a PR merged. Here, you have to call specifically call the @/all-contributors bot and ask it to update the README once a PR is merged.

@all-contributors please add @V2dha for code or @all-contributors please add @V2dha for docs, review

And the bot will create a PR.

Let me know which one should I go ahead with?

V2dha commented 3 years ago

@tusharnankani Thank you for the detailed explanation! I think the dynamic one would be good with @all-contributors bot. The contributors themselves can call the bot to update the README once their PR gets merged.

tusharnankani commented 3 years ago

The contributors themselves can call the bot to update the README once their PR gets merged.

@V2dha The owner/maintainer of the repository has to comment on it.

V2dha commented 3 years ago

The contributors themselves can call the bot to update the README once their PR gets merged.

@V2dha The owner/maintainer of the repository has to comment on it.

Then I can think static one is fine for now. Will consider the bot one some other time.

tusharnankani commented 3 years ago

Then I can think static one is fine for now. Will consider the bot one some other time.

Alright! Going ahead with the first one.

tusharnankani commented 3 years ago

@V2dha does this come under any level in DWOC?

V2dha commented 3 years ago

@V2dha does this come under any level in DWOC?

Yes it does. I'll add the suitable level with dwoc tag.