ghiqc (GitHub Issues Quality Checker)

GitHub Issues 中检查问题报告质量的命令行工具。

动机。问题报告的质量对于软件项目的整体质量至关重要：表述不当的问题报告往往会导致时间浪费、程序员沮丧和延误。这个仓库是一个命令行工具，可以扫描给定的问题，检查其表述中的质量问题，生成建议，并向问题报告作者报告请求修复。

如何使用？

首先，从 crate 安装它

cargo install ghiqc

或使用 homebrew（macOS）

brew install ghiqc

然后运行它

ghiqc --repo h1alexbel/fakehub --issue 1

CLI 选项

您可以在 ghiqc 命令行工具中使用以下选项

ghiqc 还会寻找两个其他参数：GITHUB_TOKEN 和 DEEPINFRA_TOKEN。它们应位于您的环境变量中。按照以下方式导出它们

export GITHUB_TOKEN=...
export DEEPINFRA_TOKEN=...

使用 GitHub Actions

为了在 GitHub Actions 中使用 ghiqc，您可以进行以下配置

name: ghiqc
on:
  issues:
    types: [ opened ]
permissions:
  issues: write
  contents: read
env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  DEEPINFRA_TOKEN: ${{ secrets.DEEPINFRA_TOKEN }}
  ISSUE: ${{ github.event.issue.number }}
jobs:
  check:
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v4
      - name: Install ghiqc
        run: cargo install ghiqc
      - name: Run ghiqc
        run: |
          ghiqc --repo "${{ github.repository }}" --issue "$ISSUE"

如何贡献？

确保您已经在系统上安装了 Rust 和 just，然后从本仓库分叉，进行更改，向我们发送 pull request。我们将审查您的更改，并在不违反我们的质量标准的情况下尽快将其应用到 master 分支。为了避免挫败感，在发送 pull request 之前，请运行完整的构建。

just build

以下是由 贡献关键指标（每小时更新一次！）提供的 zerocracy/judges-action。