Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/h1alexbel/ghiqc
Command-line tool for checking the quality of your bug reports in GitHub Issues, empowered with LLM
https://github.com/h1alexbel/ghiqc
bug-reports cli github-issues llm quality-control rust
Last synced: about 1 month ago
JSON representation
Command-line tool for checking the quality of your bug reports in GitHub Issues, empowered with LLM
- Host: GitHub
- URL: https://github.com/h1alexbel/ghiqc
- Owner: h1alexbel
- License: mit
- Created: 2024-07-25T11:36:08.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-11-05T07:09:22.000Z (about 2 months ago)
- Last Synced: 2024-11-05T08:19:16.883Z (about 2 months ago)
- Topics: bug-reports, cli, github-issues, llm, quality-control, rust
- Language: Rust
- Homepage:
- Size: 1.86 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ghiqc (GitHub Issues Quality Checker)
[](http://www.rultor.com/p/h1alexbel/ghiqc)
[](https://www.jetbrains.com/idea/)
[](https://github.com/h1alexbel/ghiqc/actions/workflows/just.yml)
[](https://crates.io/crates/ghiqc)
[](https://codecov.io/gh/h1alexbel/ghiqc)
[](http://www.0pdd.com/p?name=h1alexbel/ghiqc)
[](https://hitsofcode.com/view/github/h1alexbel/ghiqc)
[](https://github.com/h1alexbel/ghiqc/blob/master/LICENSE.txt)
[](https://snyk.io/test/github/h1alexbel/ghiqc)
Command-line tool for checking quality of bug reports in GitHub Issues,
with a help of [LLM].
**Motivation**.
The quality of bug reports is paramount for the overall quality of a
software project: [poorly formulated bug reports][right-way-to-report-bugs]
often lead to wasted time, programmers frustration, and delays. This repository
is a command-line tool that would scan given issue for quality problems in its
formulations, generate recommendation, and report to the bug report author
asking to fix the report.
## How to use?
First, install it from [crate][ghiqc-crate]:
```bash
cargo install ghiqc
```
or with [homebrew] (macOS):
```bash
brew install ghiqc
```
Then, run it:
```bash
ghiqc --repo h1alexbel/fakehub --issue 1
```
### CLI Options
You can use the following options within `ghiqc` command-line tool:
| Name | Value | Default | Description |
|-------------------|---------|---------|----------------------------------------------------------------|
| `--repo`, `-r` | String | - | Repository to check, in @owner/repo format, i.e. `jeff/foo`. |
| `--issue`, `-i` | int | - | Issue number to check. |
| `--stdout` | boolean | `false` | Print the result to the console, instead of posting on GitHub. |
| `--verbose`, `-v` | boolean | `false` | Verbose run output, i.e. debug logs, etc. |
There are two more arguments `ghiqc` will look for: `GITHUB_TOKEN` and
`DEEPINFRA_TOKEN` (you can obtain it [here][Deep Infra API Tokens]). They
should be located in your environment variables. Export them like that:
```bash
export GITHUB_TOKEN=...
export DEEPINFRA_TOKEN=...
```
### Ignore issues from checking
You can prevent `ghiqc` from running checks on the issue. In order to do that,
include special file `ignore.ghiqc` in the root of your repo. In this file you
can specify a list of rules - what kind of issues to ignore:
```text
author:jeff
label:enhancement
title:new feature request
title:!*something
```
We support the following issue scope dimensions: `author`, `label`, and
`title`. Supported syntax features:
* assignment: `author:jeff`
* exclusion: `label:!bug`
* multiple values with `author` and `label`: `author:[jeff,foo,max]`,
`label:[enhancement]`
* multiple values to exclude with `author` and `label`: `author:![jeff,foo]`,
`labelL:![bug,question]`
* "starts with" with `title`: `title:*this is feature request:`
* "starts with" exclusion with `title`: `title:!*BUG:`, thus it will skip
everything that not starts with `BUG:`.
### Using with GitHub Actions
In order to use `ghiqc` within [GitHub Actions], you can make the following
configuration:
```yml
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"
```
## How to contribute?
Make sure that you have [Rust] and [just] installed on your system, then fork
this repository, make changes, send us a [pull request][guidelines]. We will
review your changes and apply them to the `master` branch shortly, provided
they don't violate our quality standards. To avoid frustration, before sending
us your pull request please run full build:
```bash
just build
```
Here is the [contribution vitals][Zerocracy Vitals], made by [zerocracy/judges-action]
(updated every hour!).
[right-way-to-report-bugs]: https://www.yegor256.com/2018/04/24/right-way-to-report-bugs.html
[ghiqc-crate]: https://crates.io/crates/ghiqc
[homebrew]: https://brew.sh
[Rust]: https://www.rust-lang.org/tools/install
[guidelines]: https://www.yegor256.com/2014/04/15/github-guidelines.html
[just]: https://just.systems/man/en/chapter_4.html
[Zerocracy Vitals]: https://www.h1alexbel.xyz/ghiqc/zerocracy/ghiqc-vitals.html
[zerocracy/judges-action]: https://github.com/zerocracy/judges-action
[GitHub Actions]: https://github.com/features/actions
[Deep Infra API Tokens]: https://deepinfra.com/dash/api_keys
[LLM]: https://en.wikipedia.org/wiki/Large_language_model