victor-gp / cmd-help-sublime-syntax

Sublime Syntax definition for sharkdp/bat to colorize command --help messages.
MIT License
21 stars 5 forks source link

Add issue forms for bugs #15

Closed victor-gp closed 1 year ago

victor-gp commented 2 years ago

GitHub documentation for issue forms.

This is a great example for what should be included in a "Bug" issue.

Requirements:

  1. command where the bug happens
  2. description of the bug, left to the reporter's discretion. Ideally, one of:
    • screenshot of the bug
    • line in the help message where the bug appears, plus its pattern (e.g.: "arg1:arg2 arguments")
  3. full help message
  4. version number for the command where the bug happens

For easier copypasting, help message & version number should be 2 separate input fields.

victor-gp commented 2 years ago

Here's an example of how issue forms work on the Homebrew repo:

victor-gp commented 2 years ago

Nice-to-haves:

This would be a "Bug" template, but there should be an "Other" template that lets people report whatever, without constraints. I can probably handle that by enabling blank issues.

DoD for this issue, first iteration:

victor-gp commented 1 year ago

Closing this after the last few commits.