good first issues

好的第一个问题

从您的CLI中找到好的第一个问题！

安装好的第一个问题

需要Python 3.6.1或更高。

$ pip3 install good-first-issues --upgrade

CLI使用别名gfi运行命令。

内容

• 安装好的第一个问题
• 内容
  • 创建GitHub个人访问令牌
• 用法
  • 搜索问题
    • 查询组织中的所有存储库
    • 查询组织中的单个存储库
    • 查询用户配置文件中的所有存储库
    • 查询用户配置文件中的单个存储库。
  • 搜索Hacktoberfest批准的问题
    • 查询所有回购与主题hacktoberfest
    • 查询组织或用户配置文件中的所有回购
  • 更改输出限制
  • 在浏览器上查看问题
• 贡献

创建GitHub个人访问令牌

CLI需要GitHub个人访问令牌才能向GitHub API提出请求。

获取github细粒度的个人访问令牌

您可以在令牌中添加描述，选择“公共存储库（仅读取）”，然后选择“生成令牌” 。

为CLI提供令牌：

$ gfi config

令牌本地存储在/home/<username>/.gfi/good-first-issues username>/.gfi/good-first-issues文件上。

设想变量中的令牌：

将GFITOKEN存储在您的环境中。

用法

GitHub提供了获取用户和组织数据的API。身份验证和数据获取需要个人访问令牌。

搜索问题

要查找问题，请使用gfi search命令。

查询组织中的所有存储库

$ gfi search " rust-lang "

演示

查询组织中的单个存储库

$ gfi search " facebook " --repo " jest "

演示

查询用户配置文件中的所有存储库

$ gfi search " yankeexe " --user

演示

查询用户配置文件中的单个存储库。

--user这里不需要用户标志。

$ gfi search " yankeexe " --repo " good-first-issues "

演示

搜索Hacktoberfest批准的问题

查询所有回购与主题hacktoberfest

$ gfi search --hacktoberfest

$ gfi search -hf

演示

查询组织或用户配置文件中的所有回购

在组织中查询所有回购中的所有存储库。

$ gfi search " facebook " --hacktoberfest

演示

在用户配置文件中查询所有用户“ hacktoberfest”的存储库。 --user这里不需要用户标志。

$ gfi search " yankeexe " --hacktoberfest

演示

更改输出限制

默认情况下，输出仅限于显示10个问题。使用--limit标志来设置输出的问题数量或无限--all 。

将问题限制为12

$ gfi search " facebook " --limit 12

演示

查看所有发现的问题。

$ gfi search " rust-lang " --all

在浏览器上查看问题

当您启用--all Flag时，很难浏览所有问题，您可以轻松地使用--web标志来轻松查看浏览器上的问题。

$ gfi search " facebook " --all --web

演示

贡献

有关建立开发环境以及如何为good-first-issues做出贡献的指南，请参见贡献指南。