Browse Source

Update 'README.md'

天问 2 years ago
parent
commit
6f8b4d0544
1 changed files with 43 additions and 1 deletions
  1. 43 1
      README.md

+ 43 - 1
README.md

@@ -1,3 +1,45 @@
 # AutoPR
 
-Fix issues with AI-generated pull requests, powered by ChatGPT
+Fix issues with AI-generated pull requests, powered by ChatGPT
+
+<table align="center">
+  <tr>
+    <td>
+      <video src="https://user-images.githubusercontent.com/24586651/235325137-b4283565-f759-48f8-9e8b-39df144e0eb7.mov">
+    </td>
+  </tr>
+</table>
+
+
+## Usage
+
+1、把 AutoPR 设置到项目中
+
+创建 .github/workflows/autopr.yml, 模板:https://github.com/irgolic/AutoPR-template/blob/main/.github/workflows/autopr.yml
+
+里面设置一下openai key
+
+2、创建一个label,名称 AutoPR
+
+3、new 一个 issue,包含清晰的问题和步骤描述。
+
+4、增加 AutoPR 标签到这个 issue
+
+自动触发 action,创建 autopr/issue-#  分支,并发起 pull request
+
+5、人工 Review 代码,合并代码
+
+## 源码分析
+
+
+
+## 💎 Examples
+
+Well-written issues often lead to better results.
+
+- [Create a dice rolling bot](https://github.com/irgolic/AutoPR-template/pull/21)
+- [Create a 'Tech Jargon Generator'](https://github.com/irgolic/AutoPR-template/pull/13)
+- [Create a user-friendly weather app](https://github.com/irgolic/AutoPR-template/pull/15)
+- [Write three programming interview challenges](https://github.com/irgolic/AutoPR-template/pull/11)
+- [Replace `GPT2FastTokenizer` with `tiktoken`](https://github.com/irgolic/AutoPR/pull/44)
+