Skip to content
This repository was archived by the owner on Mar 5, 2026. It is now read-only.

Commit bb3ca73

Browse files
committed
README: update for archival
1 parent 0b72940 commit bb3ca73

1 file changed

Lines changed: 27 additions & 29 deletions

File tree

README.md

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,44 @@
11
<div align="center">
22

3-
# 🚀 AutoPR 🚀
4-
5-
[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label&color=purple)](https://discord.gg/ykk7Znt3K6)
6-
3+
<img src="website/static/img/AutoPR_Mark_color.png" alt="AutoPR logo" width=150 />
74

5+
<h1>🌳 AutoPR 🌳</h1>
6+
87
<table align="center">
9-
<tr>
10-
<td>
8+
<tr >
9+
<td width=400 >
1110
<video src="https://user-images.githubusercontent.com/24586651/235325137-b4283565-f759-48f8-9e8b-39df144e0eb7.mov">
1211
</td>
1312
</tr>
1413
</table>
1514

16-
17-
AutoPR autonomously writes pull requests in response to issues with ChatGPT.
18-
Get started with [AutoPR-template](https://github.com/irgolic/AutoPR-template).
19-
Built with [Guardrails](https://github.com/ShreyaR/guardrails) and [Langchain](https://github.com/hwchase17/langchain).
15+
AutoPR autonomously wrote pull requests in response to issues.
16+
Built with [Guardrails](https://github.com/guardrails-ai/guardrails).
2017

2118
</div>
2219

23-
## 💪 How does it work?
20+
## What is this?
21+
22+
A vision of user experience I had in March of 2023, back when OpenAI had just launched its first "ChatGPT API".
23+
24+
As far as I am aware, AutoPR was the first bot to autonomously generate pull requests in response to issues.
25+
Like most demos back in the day, it worked about 20% of the time.
2426

25-
Triggered by adding a label containing `AutoPR` to an issue, AutoPR will:
27+
What inspired the initial weekend coding sprint was [Guardrails](https://github.com/guardrails-ai/guardrails),
28+
who were prompting LLMs to generate structured data with JSON Schemas, and reasking it when it did not adhere.
29+
This was a time before grammar-powered structured data generation.
30+
31+
Enjoy this brief glimpse into the past. 🜂
32+
33+
## 💪 How did it work?
34+
35+
Triggered by adding a label containing `AutoPR` to an issue, AutoPR would:
2636

2737
1. Plan a fix
2838
2. Write the code
2939
3. Push a branch
3040
4. Open a pull request
3141

32-
## 📍 Roadmap
33-
34-
- [X] Automatically write pull requests based on labeled issues
35-
- [X] Autonomously generate code through iterative and adaptive planning
36-
- [ ] Vector search through repository contents (https://github.com/irgolic/AutoPR/issues/55)
37-
- [ ] Improving codegen performance (https://github.com/irgolic/AutoPR/issues/56)
38-
- [ ] Iterate with PR comments and code review (https://github.com/irgolic/AutoPR/issues/31)
39-
- [ ] ChatGPT plugin that writes an issue during the course of a conversation
40-
- [ ] User-configurable tasks like "add tests", "add docs", "add type hints"
41-
- [ ] User-configurable semantic CI checks like "if file x changes, ensure file y reflects the change"
42-
- [ ] Autonomous PR reviewer who pushes to your branch
43-
4442
## 💎 Examples
4543

4644
Well-written issues often lead to better results.
@@ -54,14 +52,14 @@ Well-written issues often lead to better results.
5452

5553
## 🤞 Limitations
5654

57-
This GitHub Action is **in development**, and in **alpha release**.
55+
This GitHub Action was **in development**, and in **alpha release**.
5856

5957
It still:
6058

61-
- [Incorrectly references](https://github.com/irgolic/AutoPR-template/pull/19/files#diff-830c8547feabc5e216043b6af2f7784ee819537d88219e607543a899db1853c0R17) code in other files
62-
- [Duplicates lines](https://github.com/irgolic/AutoPR/pull/44/files#diff-8427d3dc331c8d06d0eca82385f08cb9878240db18a867f463ae90afab6ded43R135)
63-
- Calls [functions that don't exist](https://github.com/irgolic/AutoPR-template/pull/9/files#diff-01de17011a56527deac53327fec7f83279509157a1e806a2cec5c2215a953e97R63)
64-
- Only works on GitHub (see [#46](https://github.com/irgolic/AutoPR/issues/46))
59+
- [Incorrectly referenced](https://github.com/irgolic/AutoPR-template/pull/19/files#diff-830c8547feabc5e216043b6af2f7784ee819537d88219e607543a899db1853c0R17) code in other files
60+
- [Duplicated lines](https://github.com/irgolic/AutoPR/pull/44/files#diff-8427d3dc331c8d06d0eca82385f08cb9878240db18a867f463ae90afab6ded43R135)
61+
- Called [functions that don't exist](https://github.com/irgolic/AutoPR-template/pull/9/files#diff-01de17011a56527deac53327fec7f83279509157a1e806a2cec5c2215a953e97R63)
62+
- Only worked on GitHub (see [#46](https://github.com/irgolic/AutoPR/issues/46))
6563

6664
## 🔨 Usage
6765

0 commit comments

Comments
 (0)