Commit
Β·
1f458f2
1
Parent(s):
0d9d86e
Update README.md
Browse files
README.md
CHANGED
@@ -1,10 +1,42 @@
|
|
1 |
---
|
2 |
title: README
|
3 |
emoji: π
|
4 |
-
colorFrom:
|
5 |
-
colorTo:
|
6 |
sdk: static
|
7 |
pinned: false
|
8 |
---
|
9 |
|
10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
---
|
2 |
title: README
|
3 |
emoji: π
|
4 |
+
colorFrom: grey
|
5 |
+
colorTo: purple
|
6 |
sdk: static
|
7 |
pinned: false
|
8 |
---
|
9 |
|
10 |
+
<p align="center">
|
11 |
+
<img src="https://github.com/sweepai/sweep/assets/26889185/39d500fc-9276-402c-9ec7-3e61f57ad233">
|
12 |
+
</p>
|
13 |
+
<p align="center">
|
14 |
+
<i>Bug Reports & Feature Requests βΆ Code Changes</i>
|
15 |
+
</p>
|
16 |
+
|
17 |
+
<b>Sweep</b> is an AI junior developer that transforms bug reports & feature requests into code changes.
|
18 |
+
|
19 |
+
Describe bugs, small features, and refactors like you would to a junior developer, and Sweep:
|
20 |
+
1. π reads your codebase
|
21 |
+
2. π plans the changes
|
22 |
+
3. β‘**writes a pull request with code**β‘
|
23 |
+
|
24 |
+
### Features π
|
25 |
+
|
26 |
+
* π Turns issues directly into pull requests (without an IDE)
|
27 |
+
* π Addresses developer replies & comments on its PRs
|
28 |
+
* π Uses embedding-based code search
|
29 |
+
|
30 |
+
## Getting Started π
|
31 |
+
|
32 |
+
Install Sweep by adding the [**Sweep GitHub app**](https://github.com/apps/sweep-ai) to your desired repositories.
|
33 |
+
|
34 |
+
For more details, visit our [β¨ Installation](docs/installation.md) page if it doesn't automatically bring you there.
|
35 |
+
|
36 |
+
## Limitations of Sweep β οΈ
|
37 |
+
|
38 |
+
* ποΈ **Large-scale refactors**: >3 files or >150 lines of code changes (we're working on this!)
|
39 |
+
* e.g. Refactor the entire codebase from Tensorflow to PyTorch
|
40 |
+
|
41 |
+
* πΌοΈ **Editing images** and other non-text assets
|
42 |
+
* e.g. Use the logo to create favicons for our landing page
|