Skip to content

Latest commit

 

History

History
99 lines (83 loc) · 10.1 KB

README.md

File metadata and controls

99 lines (83 loc) · 10.1 KB
Raw

GoodFirstIssue

Twitter URL good first issues

This is a tool listening to webhook events from goodfirstissue github app which configures a webhook for listening to issues github-event.

It tweets the link to issue through @goodfirstissue twitter handle if:

  • The issue has good first issue or good-first-issue label AND
  • if action is one of opened, reopened, labeled or unassigned.

The target audience (or followers) for this twitter account are users who are looking forward for starting their journey in open source contributions and target audience for this app are github users/org who encourage first time contributors to make contributions to their repo(s).

How to Install

  • Go to https://github.com/apps/goodfirstissue
  • Click on Configure
  • Select the User/Org which owns the repo where you plan to install this app.
  • Confirm Password (required by github). App don't get access to this password.
  • Refer that only read access is required to issues and metadata.
  • From Repository Access box, select the repositories where you want to enable it. You can enable for all or only selected repositories.
  • Click Save and you are all set.

Permissions required

The github app needs read access to issues and metadata of the repository. Refer to the screenshot below:

Permissions

Current users

Orgs/Users who have enabled goodfirstissue for atleast one repository (generated using github-app-installations)

                                                                                                                       

Acknowledgements

Many thanks to Alex Ellis for helping me write, build, and host this as openfaas-function on openfaas-cloud for more than four years without costing a dime to me. I will be thankful forever for that.