github-issue-prompter

使用AI找到你可以工作的GitHub问题（即使这些问题看起来很活跃）！

关于

在GitHub上筛选开放的问题可能很困难，尤其是当它们看起来很繁忙或处于悬而未决状态时。这个Python工具使用AI分析GitHub问题，找到那些可以工作的（即使它们看起来很繁忙/已被占用），并为看起来陈旧的问题提出评论，或者提供解决方案的机会。减轻自己筛选问题的压力！

安装

使用pip直接从PyPI安装

pip install github-issue-prompter

令牌

你需要一个GitHub个人访问令牌和一个OpenAI API令牌（以使用AI功能）。您可以将它们存储在 PROMPTER_GITHUB_TOKEN 和 PROMPTER_OPENAI_TOKEN 环境变量中，或者将它们作为参数传递。

如何从您的GitHub帐户获取GitHub个人访问令牌的说明 在此。

如何获取OpenAI API令牌的说明 在此。

用法

您可以在组织内搜索问题，或在单个存储库中搜索。结果将显示建议的评论以开始，或者您可以使用 post_comments 参数自动发布评论！

安装完成后，您可以使用命令行和prompt命令，并使用您希望的参数。

prompt -h

prompt pytorch -r pytorch

或者，您可以通过Python导入和调用脚本。

from github_issue_prompter import prompt_issues

prompt_issues(
    organisation="pytorch",
    repository="pytorch",
)

如果您无法访问OpenAI API，或者只想使用更基本的功能，可以使用-s/--simple命令行参数，或者使用mode="simple"关键字参数。

开发

分支和克隆代码库

git clone https://github.com/itsluketwist/github-issue-prompter.git

克隆完成后，在虚拟环境中本地安装包

python -m venv venv

. venv/bin/activate

pip install -e ".[dev]"

安装并使用pre-commit以确保代码状态良好

pre-commit install

pre-commit autoupdate

pre-commit run --all-files

测试

(待办事项...) 使用以下方法运行测试套件

pytest .

灵感

当我开始接触开源时，我发现许多问题处于不确定的状态。要么被分配但看起来没有活动，要么未分配但有评论暗示有人在处理它。这使得很难找到合适的问题开始，我认为有一个自动工具来扫描这些问题并提示分配者/维护者澄清状态将非常方便。

待办事项

• 实现一些测试
• 扩展使用案例和上述说明
• 所有API提示配置/选项