search

romie-gr / romie

Rom scraper for emulatorgames.net
https://romie-gr.github.io/romie/
Apache License 2.0
4 stars 9 forks source link

Mention contributors #30

Closed drpaneas closed 3 years ago

drpaneas commented 4 years ago

Description

There are many ways to highlight your contributors. One of those is via the readme. There are plenty of ways to do it. Check other github repos do get inspired.

Acceptance Criteria

drpaneas commented 4 years ago

use the all contributors bot

ktsamis commented 4 years ago

Example of result of all-contributors-bot. Basically with a comment we can add contributors, it opens a new PR with the person's profile etc, you can see an example PR here and the initial PR for the first one here. The only thing we need to do is install the all-contributors-bot and then in a PR that we have open start mentioning all the people that have contributed for each reason. Let's talk about what we want to have as types in the table configuration

ktsamis commented 4 years ago

I think the defaults are enough, I would like to use it a few times to see if the links are what we need for code, tests etc. I see the code is at least. @drpaneas what do you think?

ktsamis commented 4 years ago

Also the current file will need to be removed, the Contributors will be added to the README

drpaneas commented 4 years ago

you can see an example PR here and the initial PR for the first one here.

Great work! Thanks for the verification :)

The only thing we need to do is install the all-contributors-bot

Already done.

and then in a PR that we have open start mentioning all the people that have contributed for each reason. Let's talk about what we want to have as types in the table configuration

Please prepare the PR ;) No need to discuss the types, put whatever you see fit based on your judgement.

Also the current file will need to be removed, the Contributors will be added to the README

Need? The AUTHORS file is considered as a best practice for GH repos. In that file we will add the whole team (internal). This card is just for enhancing the exposure of our contributors (external people).

ktsamis commented 3 years ago

I will leave the defaults, I think they are good enough for us now. If we need more in the future we can add it. Basically from now if we want to add contributors a comment will be enough