# GitHub

### BetterBugs integration with GitHub

BetterBugs and GitHub integration enables you to raise issues directly to your GitHub repo as GitHub issues. You can create a visual bug report with all the details you need to highlight to share the issue with your teammates and raise the issue directly on your GitHub repo.

### How to Integrate BetterBugs Project with GitHub: Step-by-Step

{% hint style="info" %}
Here, we've covered the steps to integrate a single BetterBugs project (within your BetterBugs Workspace) with GitHub. You can also integrate the complete BetterBugs Workspace in one go (that includes all the projects within your Workspace) to GitHub or any other project tool. [**Check out the steps for Workspace Integration**](https://docs.betterbugs.io/dashboard/workspace-settings/integrations/workspace-integration)**.**
{% endhint %}

{% stepper %}
{% step %}

#### Open Workspace Settings > Integrations

Click on BetterBugs Workspace name at the top left side of app screen. Now, click the **gear icon** to open **Workspace Settings** > **Integrations**.
{% endstep %}

{% step %}

#### Search GitHub

In the **Integrations** tab, search for **GitHub** and click to open the **GitHub** card.
{% endstep %}

{% step %}

#### Turn off workspace-wide integration

Toggle off the "**All Projects**" option and hit "**Continue**". You should see the "**Manage per project**" option now.

{% hint style="info" %}
By default, its turned on for workspace level integration. For project-wise integration, you need to disable "**All Projects**".
{% endhint %}
{% endstep %}

{% step %}

#### Select a BetterBugs project to integrate and hit "Connect"

Select a project from the projects name list (that's within your Workspace). From the "**Actions**" column, hit "**Connect**" for that project.
{% endstep %}

{% step %}

#### **Authorize BetterBugs.io for GitHub**

Authorize BetterBugs.io for your GitHub account.

{% hint style="warning" %}
**IMPORTANT NOTE** 

If you're on a **free plan**, Steps 6 and 7 are **NOT REQUIRED**. **You can just SKIP** to "*How to Raise an Issue on GitHub using BetterBugs*" section on this page.

**FOR PAID PLANS (Teams and Enterprise)**

Steps 6 and 7 enables you to explicitly choose between:

* **Manual Issue Creation (Default)**: This means for sharing a bug report to GitHub, you'd need to manually populate fields for your GitHub Repo. (**Repository**, **Assignees**, **Labels**, and others). Its a **FREE FEATURE**.
* **Automatic Issue Creation:** This means for sharing a bug report to GitHub Repo, you can configure BetterBugs to auto-populate fields for GitHub (**Repository**, **Assignees**, **Labels**, and others). Its a **PAID FEATURE**.
  {% endhint %}
  {% endstep %}

{% step %}

#### Optional: Choose your preferred method for creating tickets: Manually or Automatically

From the "**Forward Bug Reports**" dropdown, select your preferred method for creating tickets in your project tool:

* **Manually**: Enables you to **raise issues manually**. *Here, we've selected the manual method to showcase project integration steps.*
* **Automatically**: Enables you to [**raise issues with automation**](https://docs.betterbugs.io/dashboard/workspace-settings/integrations/project-integration/project-automation).
  {% endstep %}

{% step %}

#### Optional: Select "Manually" and Connect

Finally, select "**Manually**" from the "**Forward Bug Reports**" dropdown and hit "**Connect**".
{% endstep %}
{% endstepper %}

Okay! You're good to go with the Project level integration for GitHub. Now, you can create detailed reports and share them as GitHub issues directly from your browser with a few clicks.

### How to Raise an Issue on GitHub using BetterBugs

{% stepper %}
{% step %}

#### Capture the Bug and Add Bug Details

Use the BetterBugs extension to capture the bug and add details for it. You can add the details (*Title + Quick Summary + Steps to Reproduce*) manually in the description area manually or automatically with the "**AI**" toggle.
{% endstep %}

{% step %}

#### Select BetterBugs Workspace and Project Integrated with GitHub

From the two dropdowns above the description area, select:

* **BetterBugs Workspace**
* **BetterBugs Project** (that you integrated with GitHub)
  {% endstep %}

{% step %}

#### Click "+ Send to your PM Tool" Dropdown and Select GitHub Issue

Open "**+ Send to your PM Tool**" dropdown and select "**GitHub Issue**".
{% endstep %}

{% step %}

#### **Populate Issue Details for GitHub and Hit "Next"**

Populate GitHub Fields for the report: **Repository**, **Assignees**, **Labels**, and others and click "**Next**".
{% endstep %}

{% step %}

#### Create Session

From the top right, click "**Create Session**".
{% endstep %}
{% endstepper %}

There you go!

A new tab with the GitHub issue opens up posting the task to the GitHub repo packed with all the bug details and a link to the **complete bug report** with [**developer tools info**](https://docs.betterbugs.io/product-features/developer-tools).

* Use the report link in your GitHub issue to access the complete report on BetterBugs.
* You can also access the GitHub issue from the BetterBugs report from the "[**Comments & Activities**](https://docs.betterbugs.io/product-features/comments-activities)" tab located below the bug description area.

### How to Send Existing BetterBugs Report to GitHub

{% stepper %}
{% step %}

#### Open a Bug Report

Login to BetterBugs and open a project report to share on GitHub.
{% endstep %}

{% step %}

#### Click "+ Send to your PM Tool" Dropdown and Select GitHub Issue

From the top-right of the report screen, open "**+ Send to your PM Tool**" dropdown and select "**GitHub Issue**".
{% endstep %}

{% step %}

#### Populate Issue Details for GitHub and Click "Create Task"

Populate GitHub Fields for the report: **Repository**, **Assignees**, **Labels**, and others and click "**Create Task**".
{% endstep %}
{% endstepper %}

Okay! You're all set. This instantly should create GitHub issue with the BetterBugs bug report.

### How to Disconnect BetterBugs Project from GitHub

{% stepper %}
{% step %}

#### Open Project Settings

Use the **Gear Icon** beside the **BetterBugs Project** **Name** to open **Project Settings**.
{% endstep %}

{% step %}

#### Go to Workspace Settings > Integrations

Navigate to **Workspace Settings** > **Integrations**
{% endstep %}

{% step %}

#### Search GitHub

In the **Integrations** tab, search for **GitHub** and click to open the **GitHub** card.
{% endstep %}

{% step %}

#### Select BetterBugs project to disconnect and click (⋮) under "Actions"

In the GitHub card, select the BetterBugs project (from the Project list) to disconnect. For the project, click vertical dots (**⋮**) under the **Actions** column.
{% endstep %}

{% step %}

#### Disconnect and Confirm Action

To confirm action, click "**Disconnect**" and "**Continue**".
{% endstep %}
{% endstepper %}

This instantly disconnects GitHub from the selected BetterBugs project.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.betterbugs.io/product-features/integrations/github.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.