Introduction

Bug fixing sessions are optimized for locating and fixing bugs in your codebase. While similar to code sessions, they have a specialized workflow designed to efficiently address issues.

Format

The general format of a bug fixing session is as follows:

  1. Task Definition: You provide the agent with a bug to fix, either through a GitHub issue or the dashboard.
  2. Analysis: The agent analyzes the codebase to locate the source of the bug.
  3. Implementation: The agent works on fixing the bug, which may involve modifying existing code, writing new code, or refactoring.
  4. Testing: The agent runs tests to ensure the bug is fixed and no new issues are introduced.
  5. Pull Request Creation: Once the agent is done, it creates a pull request with its changes.

Getting Started

There are two primary ways to initiate a bug fixing session:

GitHub Integration

The easiest way to start a bug fixing session is through our GitHub integration:

  1. Open an issue describing the bug on GitHub.
  2. Comment @honeycombsh fix on the issue to begin the bug fixing process.

There is no autocomplete for @honeycombsh, so you’ll need to type it out in full.

Once the agent picks up the issue, it will start working on it.

Dashboard

For more control over the session settings, you can initiate a bug fixing session from the dashboard:

  1. Navigate to the Sessions tab.
  2. Click on the ‘Begin New’ button.
  3. Select the ‘Bugfix’ card.
  4. Provide the repository, branch, and commit information.
  5. Configure setup and testing options as needed.
  6. Set a time limit for the session.
  7. Provide a detailed description of the bug and any relevant context.
  8. Optionally, include a link to the GitHub issue for additional context.

For most bug fixing tasks, choosing “None” for setup and testing, with a 1-hour time limit is a good starting point. For more complex bugs, you may want to configure custom setup and testing procedures, and allow for a longer time limit.