{"id":13478030,"url":"https://github.com/flows-network/github-pr-summary","last_synced_at":"2025-03-27T07:30:40.767Z","repository":{"id":151071183,"uuid":"619980577","full_name":"flows-network/github-pr-summary","owner":"flows-network","description":"Use LLM to summarize \u0026 review GitHub Pull Requests","archived":false,"fork":false,"pushed_at":"2024-08-05T13:01:07.000Z","size":1186,"stargazers_count":229,"open_issues_count":0,"forks_count":63,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-20T14:50:45.068Z","etag":null,"topics":["chatgpt","codereview","github","gpt4","llamaedge","llm"],"latest_commit_sha":null,"homepage":"https://flows.network/","language":"Rust","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flows-network.png","metadata":{"files":{"readme":"README-zh.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-27T19:47:50.000Z","updated_at":"2025-03-11T10:25:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"bd120de6-0ab2-49a8-b25e-ba0f6a065c3a","html_url":"https://github.com/flows-network/github-pr-summary","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flows-network%2Fgithub-pr-summary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flows-network%2Fgithub-pr-summary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flows-network%2Fgithub-pr-summary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flows-network%2Fgithub-pr-summary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flows-network","download_url":"https://codeload.github.com/flows-network/github-pr-summary/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245802192,"owners_count":20674604,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatgpt","codereview","github","gpt4","llamaedge","llm"],"created_at":"2024-07-31T16:01:51.502Z","updated_at":"2025-03-27T07:30:40.183Z","avatar_url":"https://github.com/flows-network.png","language":"Rust","readme":"\u003cdiv align=\"right\"\u003e\n\n[English](README.md)\n\n\u003c/div\u003e\n\n# \u003cp align=\"center\"\u003eChatGPT/4 加成的 Github PR 代码检查机器人\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://discord.gg/ccZn9ZMfFf\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/chat-Discord-7289DA?logo=discord\" alt=\"flows.network Discord\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://twitter.com/flows_network\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Twitter-1DA1F2?logo=twitter\u0026amp;logoColor=white\" alt=\"flows.network Twitter\"\u003e\n  \u003c/a\u003e\n   \u003ca href=\"https://flows.network/flow/createByTemplate/summarize-github-pull-requests\"\u003e\n    \u003cimg src=\"https://img.shields.io/website?up_message=deploy\u0026url=https%3A%2F%2Fflows.network%2Fflow%2Fnew\" alt=\"Create a flow\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n[部署此函数到 flows.network](#deploy-your-own-code-review-bot-in-3-simple-steps)，你将获得一个 GitHub 🤖 来检查代码和总结拉取请求。它可以帮助忙碌的开源贡献者更快地理解并对 PR 采取行动!下面是一些示例! \n\n* [[Rust] 支持 WasmEdge Rust SDK 中的主机函数](https://github.com/WasmEdge/WasmEdge/pull/2394#issuecomment-1497819842)\n* [[bash] 支持 WasmEdge 安装程序中的 ARM 体系结构](https://github.com/WasmEdge/WasmEdge/pull/1084#issuecomment-1497830324)\n* [[C++] 为 WasmEdge 添加 eBPF 插件](https://github.com/WasmEdge/WasmEdge/pull/2314#issuecomment-1497861516)\n* [[Haskell] 优化 WasmEdge Component Model 工具的 CLI 实用程序](https://github.com/second-state/witc/pull/73#issuecomment-1507539260)\n\n\u003e 还没被惊艳到吗？[请见此处 bot 指出的“潜在问题1”](https://github.com/second-state/wasmedge-quickjs/pull/82#issuecomment-1498299630)，它识别出了 Rust 算法的低效实现。🤯 \n\n这个机器人会**总结 PR 中提交的信息**。或者，可以使用[这个机器人](https://github.com/flows-network/github-pr-review)来检查PR中更改的文件。\n\n\n## 如何工作\n\n当在指定的 GitHub repo 中创建新的 PR 时，此 flow 函数（或🤖）将被触发。 flow 函数会收集 PR 中的内容，并请求 ChatGPT/4 进行检查和总结。结果会作为评论发布回 PR。flow 函数是用Rust编写的，并在[WasmEdge 运行时](https://github.com/wasmedge)上在托管的[flows.network](https://flows.network/)中运行。\n\n* 每次将新的提交推送到此 PR 时，都会自动更新代码检查评论。\n* 当有人在 PR 的评论中说出一个魔法*触发词*时，可以触发新的代码检查。默认的触发词是\"flows summarize\"。\n\n## 简单3步部署自己的代码检查机器人\n\n1. 从模板创建一个机器人\n2. 添加你的 OpenAI API密钥\n3. 配置机器人以检查指定 GitHub repo 上的PR\n\n\n### 0 前期准备\n\n需要使用自己的 [OpenAI API 密钥](https://openai.com/blog/openai-api)。如果还没有注册，请[在此处注册](https://platform.openai.com/signup)。\n\n还需要使用 GitHub 帐户登录 [flows.network](https://flows.network/)。这是免费的。\n\n### 1 从模板创建机器人\n\n### [单击此处](https://flows.network/flow/createByTemplate/Summarize-Pull-Request)\n\n请检查 `trigger_phrase` 变量。这是你在 PR 评论中手动召唤检查机器人的魔法词。\n\n单击 **Create and Build** 按钮。\n\n### 2 添加你的 OpenAI API 密钥\n\n现在你将设置 OpenAI integration。单击**连接**，输入您的密钥并为其命名。\n\n[\u003cimg width=\"450\" alt=\"image\" src=\"https://user-images.githubusercontent.com/45785633/222973214-ecd052dc-72c2-4711-90ec-db1ec9d5f24e.png\"\u003e](https://user-images.githubusercontent.com/45785633/222973214-ecd052dc-72c2-4711-90ec-db1ec9d5f24e.png)\n\n完成后关闭选项卡并返回 flow.network 页面。 点击**继续**。\n\n\u003e让我们看一个示例。你想要部署机器人从而总结 `WasmEdge/wasmedge_hyper_demo` repo 中的 PR。这里 `github_owner = WasmEdge`，`github_repo = wasmedge_hyper_demo`。\n\n单击“创建和部署（Create and deploy）”按钮。\n\n## 3 配置机器人以访问 GitHub\n\n接下来，你需要告诉机器人它需要监控哪个 GitHub repo 以查看即将到来的 PR 进行检查。\n\n* `github_owner`:  *你想要为 repo 部署 🤖 的* GitHub org\n* `github_repo` :  *你想部署 🤖 的* GitHub repo\n\n\u003e 让我们看一个例子。您想要部署机器人来检查`WasmEdge/wasmedge_hyper_demo` repo 中的PR代码。这里 `github_owner = WasmEdge` 且 `github_repo = wasmedge_hyper_demo`。\n\n点击 **Connect** 或 **+ Add new authentication** 按钮，以使函数可以访问 GitHub repo 并部署🤖️。你将被重定向到一个新页面，在此页面须授予 [flows.network](https://flows.network/) 对该 repo 的权限。\n\n[\u003cimg width=\"450\" alt=\"image\" src=\"https://github.com/flows-network/github-pr-summary/assets/45785633/6cefff19-9eeb-4533-a20b-03c6a9c89473\"\u003e](https://github.com/flows-network/github-pr-summary/assets/45785633/6cefff19-9eeb-4533-a20b-03c6a9c89473)\n\n完成后请关闭标签页并返回 flow.network 页面。点击 **Deploy**.\n\n这就好了！你现在处在 flow 详细信息页面，正在等待 flow 函数构建。一旦 flow \n状态变为 `运行中`，机器人就准备好进行代码检查了！每个新PR、每个新提交以及PR评论中的魔法词（即`trigger_phrase`），都会召唤机器人。\n\n[\u003cimg width=\"450\" alt=\"image\" src=\"https://user-images.githubusercontent.com/45785633/229329247-16273aec-f89b-4375-bf2b-4ffce5e35a33.png\"\u003e](https://user-images.githubusercontent.com/45785633/229329247-16273aec-f89b-4375-bf2b-4ffce5e35a33.png)\n\n\n\n## 常见问题解答\n\n### 自定义机器人\n\n机器人的源代码可在你从模板克隆的 GitHub repo 中找到。请根据自己的需求任意更改源代码（例如，模型、上下文长度、API 密钥和提示）。如果需要帮助，请在 [Discord 中询问](https://discord.gg/ccZn9ZMfFf)！\n\n\n### 使用 GPT4\n\n默认情况下，该机器人使用 GPT3.5 进行代码审核。如果你的 OpenAI API 密钥可以访问 GPT4，则可以在克隆的源代码 repo 中打开 `src/github-pr-review.rs` 文件，并在源代码中将 `GPT35Turbo` 更改为 `GPT4`。将更改提交并推送回 GitHub。\nflows.network 平台将自动检测并从你的更新的源代码重建机器人。\n\n\n### 在多个 repo 上使用机器人\n\n你可以手动[创建一个新的 flow](https://flows.network/flow/new)，并导入机器人的源代码 repo（即你从模板克隆的 repo）。然后，可以使用 flow config 来指定 `github_owner` 和 `github_repo`，以指向你需要在其上部署机器人的目标 repo。部署并授权访问该目标 repo。\n\n可以把这个机器人安装在你想要部署此机器人的所有目标 repo 上。\n\n\u003e你可以将单个 flow 函数 repo 部署为多个机器人的源代码。当更新 repo 中的源代码并将其推送到 GitHub 时，会更改所有机器人的行为。\n\n\n### 定制自己的魔法词\n\n进入机器人正在运行的 flow 函数的 \"Settings\" 选项卡，你可以更新 `trigger_phrase` 配置。该配置的值是让用户触发机器人的魔法词，可以从 PR 评论触发检查。\n\n\n## 鸣谢\n\n此 flow 函数最初由 [Jay Chen](https://github.com/jaykchen) 创建，[jinser](https://github.com/jetjinser) 为优化来自 GitHub 的事件触发器做出了重大贡献。\n\n\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://www.producthunt.com/posts/gpt-nitro-for-github-pr?utm_source=badge-featured\u0026utm_medium=badge\u0026utm_souce=badge-gpt\u0026#0045;nitro\u0026#0045;for\u0026#0045;github\u0026#0045;pr\" target=\"_blank\"\u003e\u003cimg src=\"https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=387993\u0026theme=light\" alt=\"GPT\u0026#0032;Nitro\u0026#0032;for\u0026#0032;Github\u0026#0032;PR - A\u0026#0032;ChatGPT\u0026#0045;based\u0026#0032;reviewer\u0026#0032;for\u0026#0032;your\u0026#0032;GitHub\u0026#0032;pull\u0026#0032;requests | Product Hunt\" style=\"width: 250px; height: 54px;\" width=\"250\" height=\"54\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n","funding_links":[],"categories":["Rust","GitHub","NLP"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflows-network%2Fgithub-pr-summary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflows-network%2Fgithub-pr-summary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflows-network%2Fgithub-pr-summary/lists"}