search

TryGhost / Ghost

Independent technology for modern publishing, memberships, subscriptions and newsletters.
https://ghost.org
MIT License
47.65k stars 10.39k forks source link

consider installing goodfirstissue app on project #10868

Closed rajatjindal closed 5 years ago

rajatjindal commented 5 years ago

Hi,

I was reading about ghost today, when I found out that ghost also has 'goodfirstissues' (from https://docs.ghost.org/concepts/contributing/) for helping new contributors.

I've developed a github bot goodfirstissue which tweets 'good first issues' via twitter handle @goodfirstissue.

the targeted audience for twitter account are first time contributors, and to encourage open source contributions.

I was hoping if you can install the app on Ghost repo (or even better if installed on TryGhost org). It needs only read access to public issues/metadata.

some open source projects like openfaas, kubernetes-helm, fastify are already using this bot to connect to first time contributors.

Some details:

Permissions this app need: read permission on issues and metadata. Twitter Handle used to tweet: @goodfirstissue Source code of the app/webhook: https://github.com/rajatjindal/goodfirstissue Instructions to install github app: https://github.com/rajatjindal/goodfirstissue#how-to-install

Thank you for considering and thank you for your contributions to open source community.

Disclaimer: i am the author of goodfirstissue bot and I am relatively new to opensource community and looking to engage more with open source contributions myself too.

Thanks Rajat Jindal

naz commented 5 years ago

Hi @rajatjindal. We would definitely like to get involved and the idea of helping new contributors find issues to work on is great!

On the other hand, we would like to keep the amount of integration to the minimum to avoid overcrowding. Just wondering why this type of checking for 'good first issues' was done through integration (which requires action/work from the repository maintainer) instead of using public GitHub API/Webhooks to get the same information?

rajatjindal commented 5 years ago

Hi Naz

Thanks for your feedback.

The github api that i am aware of allows only pull from github. I am not aware if i can configure webhooks on repos that i am not owner of. Please correct me if i am wrong here.

As you can imagine the pull operation wont scale very well and will be limited by the github api rate limits therefore we went ahead with this push operation where owner of repo can push “issues events” which involve only public metadata.

I hope that clarifies, but i am happy to chat/learn more if you think there is a better way to so it

On Thu, Jul 4, 2019 at 2:45 PM Naz Gargol notifications@github.com wrote:

Hi @rajatjindal https://github.com/rajatjindal. We would definitely like to get involved and the idea of helping new contributors find issues to work on is great!

On the other hand, we would like to keep the amount of integration to the minimum to avoid overcrowding. Just wondering why this type of checking for 'good first issues' was done through integration (which requires action/work from the repository maintainer) instead of using public GitHub API/Webhooks to get the same information?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/TryGhost/Ghost/issues/10868?email_source=notifications&email_token=AAEVN7B54ZD4HQPDNL6WL23P5W5SLA5CNFSM4H5D2V3KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZG23NY#issuecomment-508407223, or mute the thread https://github.com/notifications/unsubscribe-auth/AAEVN7DYFS2NI6KPGX6SSVLP5W5SLANCNFSM4H5D2V3A .

-- Rajat Jindal | Pune | https://rajatjindal.com | rajatjindal83@gmail.com

rajatjindal commented 5 years ago

Hi Naz

a gentle reminder to review my response when you get chance.

allouis commented 5 years ago

@gargol ^ :stuck_out_tongue:

rajatjindal commented 5 years ago

whoops. sorry about the wrong username tag

naz commented 5 years ago

Hey @rajatjindal! Sorry gotten focused on new features and had this on a waiting list :stuck_out_tongue:

Regarding webhooks, I'm not up to speed with the permission details on them, but if that requires to be an owner then definitely a no go.

The reason why I'm asking about the "no work on our side approach", is that have seen similar concept done in https://24pullrequests.com/ with them collecting issues to triage over pre-Christmas time. And in your case, it's a 'continuous' way of collecting specifically tagged issues. Wondering if they had to integrate with every single repository or had some less intrusive way to tackle this problem?

rajatjindal commented 5 years ago

Sorry when i said owner i meant a person who is authorized to make changes to the repo OR org. It can be a collaborator or member.

The model of this bot is slightly different.

In 24pullrequests (from my brief reading) it seems they pull data for projects and then store/cache and provide link to projects issues with filters. ( this is a great project between)

The idea behind goodfirstissue bot was to give realtime notification of a relevant issue to new comers. For popular repositories the new goodfirstissue issue might get taken in matter of mins, and therefore the real time notification via twitter can give opportunities to a new comer to look for that issue as soon as its reported.

I can close this issue if you think its a no-go.

I really appreciate your time to review this with me and the suggestions given. And ofcourse for your opensource contributions.

On Fri, Jul 12, 2019 at 1:54 PM Naz Gargol notifications@github.com wrote:

Hey @rajatjindal https://github.com/rajatjindal! Sorry gotten focused on new features and had this on a waiting list 😛

Regarding webhooks, I'm not up to speed with the permission details on them, but if that requires to be an owner then definitely a no go.

The reason why I'm asking about the "no work on our side approach", is that have seen similar concept done in https://24pullrequests.com/ with them collecting issues to triage over pre-Christmas time. And in your case, it's a 'continuous' way of collecting specifically tagged issues. Wondering if they had to integrate with every single repository or had some less intrusive way to tackle this problem?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/TryGhost/Ghost/issues/10868?email_source=notifications&email_token=AAEVN7HAO2EPXXKN6A2MPYLP7A5VVA5CNFSM4H5D2V3KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZZCTUQ#issuecomment-510798290, or mute the thread https://github.com/notifications/unsubscribe-auth/AAEVN7CDBTAK2CYN4QZZ5HTP7A5VVANCNFSM4H5D2V3A .

-- Rajat Jindal | Pune | https://rajatjindal.com | rajatjindal83@gmail.com

ErisDS commented 5 years ago

Hi @rajatjindal thanks for getting in touch, As you can see, we use the labels good first issue and help wanted to try to support the contributor community.

If you're able to leverage these labels to bring the issues to the attention of more people that's great, however we're not interested in installing any 3rd party apps to do this right now.