https://github.com/rajatjindal/goodfirstissue

webhook for goodfirstissue github app
https://github.com/rajatjindal/goodfirstissue

contributors github-app golang good-first-issue goodfirstissue hacktoberfest webhook

Last synced: about 1 year ago
JSON representation

webhook for goodfirstissue github app

• Host: GitHub
• URL: https://github.com/rajatjindal/goodfirstissue
• Owner: rajatjindal
• License: apache-2.0
• Created: 2019-01-26T14:21:46.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-11-13T07:18:42.000Z (over 1 year ago)
• Last Synced: 2025-03-18T11:39:17.607Z (about 1 year ago)
• Topics: contributors, github-app, golang, good-first-issue, goodfirstissue, hacktoberfest, webhook
• Language: Go
• Homepage: https://github.com/apps/goodfirstissue
• Size: 2.84 MB
• Stars: 31
• Watchers: 3
• Forks: 7
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![GoodFirstIssue](docs/goodfirstissue.png)](https://github.com/rajatjindal/goodfirstissue) 

[![Twitter URL](https://img.shields.io/twitter/follow/goodfirstissue.svg?label=Follow&style=social)](https://twitter.com/goodfirstissue) [![good first issues](https://img.shields.io/github/issues/rajatjindal/goodfirstissue/good%20first%20issue.svg

)](https://github.com/rajatjindal/goodfirstissue/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 

This is a tool listening to webhook events from [goodfirstissue](https://github.com/apps/goodfirstissue) github app which configures a webhook for listening to `issues` github-event. 

It tweets the link to issue through [@goodfirstissue](https://twitter.com/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](docs/permissions.png)

# Current users

Orgs/Users who have enabled `goodfirstissue` for atleast one repository (generated using [github-app-installations](https://github.com/rajatjindal/github-app-installations))

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

  

# Acknowledgements

Many thanks to [Alex Ellis](https://twitter.com/alexellisuk) for helping me write, build, and host this as openfaas-function on [openfaas-cloud](https://github.com/openfaas/openfaas-cloud) for more than four years without costing a dime to me. I will be thankful forever for that.