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

Show the list of contributors on README #49

Closed
amitguptagwl opened this issue Jun 21, 2018 · 6 comments
Closed

Show the list of contributors on README #49

amitguptagwl opened this issue Jun 21, 2018 · 6 comments
Labels
first-timers-only Suitable for fevelopers who are contributing first time in open source development . good first issue help wanted

Comments

@amitguptagwl
Copy link
Member

better if it is automated.

@amitguptagwl amitguptagwl added help wanted good first issue first-timers-only Suitable for fevelopers who are contributing first time in open source development . labels Jun 21, 2018
@rohitkrishna094
Copy link
Contributor

I'd like to try this. Is it ok, if I just create a new js file under js folder called contributors.js and add a script to package.json called say generateContributors? Then we can run npm generateContributors and that alone should update readme file(and add new contributors to the end). You could later on set up a cron job to run this npm generateContributors script to update as and when a new contribution occurs or on a daily or a weekly basis(as I believe from their documentation, the github api takes some time to update new contributions since they are cached).

@amitguptagwl
Copy link
Member Author

There are many npm packages already available to do this. But it'll become a manual approach in this way.

Check contribution list on Fast XML Parser. Opencollective API let you show list of contributors automatically, if you're register there. But that can be happened only when we've 100 stars on this repo.

I couldn't find other solution.

BTW Didn't you sleep today?

@rohitkrishna094
Copy link
Contributor

Haha, well I did sleep. :P

No idea about opencollective. I guess there are other APIs out there, but I thought this was simple enough to do it with vanilla nodejs.

Either way, if anyone else would like to take this issue up, they can. :)

@amitguptagwl
Copy link
Member Author

amitguptagwl commented Jun 22, 2018

I thought to implement opencollective API but it needs server to render SVG. Hence I was looking for an alternative.

Or we can merge your PR until we find the better solution.

@rohitkrishna094
Copy link
Contributor

True, without a server we can't do much. I just closed my PR. Let me reopen it and you can decide to merge it after maybe waiting for few days in case someone comes up with another alternative.

@amitguptagwl
Copy link
Member Author

amitguptagwl commented Jun 22, 2018

Merged the PR. Let this issue be open for next few days for more solutions.

I hope you would like to change your Avatar now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
first-timers-only Suitable for fevelopers who are contributing first time in open source development . good first issue help wanted
Projects
None yet
Development

No branches or pull requests

2 participants