|
--- |
|
title: README |
|
emoji: 🐠 |
|
colorFrom: grey |
|
colorTo: purple |
|
sdk: static |
|
pinned: false |
|
--- |
|
|
|
<p align="center"> |
|
<img src="https://github.com/sweepai/sweep/assets/26889185/39d500fc-9276-402c-9ec7-3e61f57ad233"> |
|
</p> |
|
<p align="center"> |
|
<i>Bug Reports & Feature Requests ⟶ Code Changes</i> |
|
</p> |
|
|
|
<b>Sweep</b> is an AI junior developer that transforms bug reports & feature requests into code changes. |
|
|
|
Describe bugs, small features, and refactors like you would to a junior developer, and Sweep: |
|
1. 🔍 reads your codebase |
|
2. 📝 plans the changes |
|
3. ⚡**writes a pull request with code**⚡ |
|
|
|
### Features 🌠 |
|
|
|
* 🌠 Turns issues directly into pull requests (without an IDE) |
|
* 👀 Addresses developer replies & comments on its PRs |
|
* 🔎 Uses embedding-based code search for your repo & external docs |
|
|
|
## Getting Started 🚀 |
|
|
|
Install Sweep by adding the [**Sweep GitHub app**](https://github.com/apps/sweep-ai) to your desired repositories. |
|
|
|
For more details, visit our [✨ Installation](docs/installation.md) page if it doesn't automatically bring you there. |
|
|
|
--- |
|
|
|
For more info, checkout our [repo](https://github.com/sweepai/sweep). |
