GFIPulse

What is it?

Good First Issue Pulse (GFIP) is a Discord bot designed to help developers find and contribute to open-source projects. It automatically alerts you about open issues that need help fixing by sending messages directly to your Discord channel. Whether you're a beginner looking to start your open-source journey or an experienced developer wanting to give back, this bot makes it easy to find good first issues and stay active.

Key Features

• 24 Hour Scheduled Notifications: Automatically alerts you about open issues in repositories that are tagged with "good first issue," ensuring you never miss an opportunity to contribute.

• Customizable Alerts: Tailor notifications to specific repositories or programming languages, so you receive updates that are most relevant to you.

• User-Friendly Interface: Designed for ease of use, GFIP integrates seamlessly with your Discord server, requiring minimal setup to get started. You won't modify any code, all you need to setup is to authorize the bot and provide commands in the discord server to customize!

Getting Started with GFIPulse

To begin using GFIP, you’ll first need to add the bot to your Discord server. Follow the steps below to install GFIPulse and start receiving notifications about good first issues.

Step 1: Authorize the Bot

To install GFIPulse, click the following link, which will redirect you to the Discord authorization page:

Authorize GFIPulse

This page allows you to grant the bot permission to interact with your Discord server.

1. Select the Server: From the drop-down menu, choose the server where you want to add the bot. You must have the "Manage Server" permission for this step.

2. Review Permissions: Review the permissions requested by the bot. GFIPulse requires certain permissions to send messages and manage channels, ensuring it can deliver notifications effectively.

3. Authorize the Bot: Click the "Authorize" button to finalize the installation. You may need to complete a CAPTCHA to prove you're not a robot.

Step 2: Configure Notifications

Once the bot is added to your server, you can configure the types of notifications you want to receive.

• Default Settings: GFIPulse comes with default settings that notify you about good first issues across every repository in GitHub.

• Custom Commands: You can customize notifications using specific commands. For example, use the command !skipWords <list of words you want to remove from notifications> (For example, if you never want to get notified about repositories related to 'hello world' you can add that to the list of skipped words). To filter issues by programming language repository you can type !setlang <language> (For example: !setlang Typescript) to filter issues by programming language.

Step 3: Start Receiving Alerts

Once configured, GFIPulse will start sending notifications directly to the designated Discord channel. You’ll receive updates about newly available good first issues, including details such as:

• Issue Title: The title of the GitHub issue that needs attention.
• Repository Link: A direct link to the repository where the issue is located.
• Labels: Labels associated with the issue, helping you identify its context and complexity.

The alerts will be sent on a daily 24 hour cadence but if they become too frequent, you can modify the frequency with the !frequency 7 days.