How to Use Sweep

Getting started with Sweep

In this guide, you will learn how to turn GitHub issues into pull requests using Sweep, an AI-powered junior developer. By the end, you'll be able to automate code changes, tests, and documentation updates efficiently.

Step 1: Sign up and set up

1. Go to Sweep's website.
2. Click on the "Sign Up" button in the top right corner.
3. Choose the "Free for Open Source" option if applicable, or select a Pro plan if you need unlimited pull requests.
4. Authorise Sweep to access your GitHub account by clicking the "Connect to GitHub" button and following the prompts.
5. Once connected, you’ll see a dashboard where you can manage your projects.

Step 2: Your first pull request

1. Navigate to the "Projects" tab on the left sidebar.
2. Click on "Create New Project" and select the GitHub repository you want to work on.
3. Go to the "Issues" section and select an issue you want to resolve.
4. Click on the "Generate Pull Request" button next to the issue.
5. Sweep will analyse the issue and your codebase, then generate the pull request. Review the code changes, tests, and documentation updates provided.
6. Click "Submit Pull Request" to create it in your GitHub repository.

Step 3: Get better results

• To improve the quality of the pull requests, make sure your GitHub issues are detailed and clear. Include specific requirements, expected outcomes, and any relevant context.
• You can also adjust settings in the "Settings" tab to choose the coding standards and testing frameworks you want Sweep to follow.

Pro tip

Set up a template for your GitHub issues. This will ensure you include all necessary details consistently, leading to better results from Sweep.

Common mistake to avoid

Avoid using vague or incomplete descriptions in your GitHub issues. Sweep relies on the information provided to generate accurate pull requests; unclear issues may result in subpar code changes or missed requirements.