R1 Automated PR Example 使用教程

1. 项目的目录结构及介绍

项目目录结构如下所示：

r1-automated-pr-example/
├── .env.example
├── .gitignore
├── README.md
├── index.ts
├── license
├── package.json
└── tsconfig.json

• .env.example：示例环境变量文件，用于展示如何配置环境变量。
• .gitignore：Git 忽略文件，列出不应该被 Git 跟踪的文件和目录。
• README.md：项目说明文件，包含项目信息和如何使用本项目。
• index.ts：项目的主执行文件，包含自动创建 PR 的逻辑。
• license：项目许可证文件，本项目采用 MIT 许可证。
• package.json：项目依赖和脚本配置文件。
• tsconfig.json：TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 index.ts。该文件中包含以下主要部分：

• 引入必要的模块和库。
• 配置环境变量。
• 初始化自动创建 PR 的逻辑。
• 执行自动创建 PR 的流程。

3. 项目的配置文件介绍

项目的配置主要通过 .env.example 文件进行。在 .env.example 文件中，你需要设置以下环境变量：

• GROQ_API_KEY：Groq API 密钥，用于项目中的查询操作。
• GITHUB_TOKEN：GitHub 个人访问令牌（PAT），需要具备仓库操作权限。
• GITHUB_OWNER：GitHub 仓库的所有者。
• GITHUB_REPO：GitHub 仓库名称。

在项目根目录下创建一个名为 .env.local 的文件，并按照 .env.example 中的格式填写你的配置信息。确保 .env.local 文件不会被 Git 跟踪。