stylix icon indicating copy to clipboard operation
stylix copied to clipboard

doc: add GitHub issue templates

Open trueNAHO opened this issue 1 year ago • 1 comments

Add GitHub issue templates to standardize issue formatting and reduce maintainer effort.

Closes: https://github.com/danth/stylix/issues/268


Cc: @danth

Currently, this patch adds an issue template only for the bug label. Once the issue template format reaches a consensus, it can be extended to all the other labels. Later, we discuss adding and removing labels.

trueNAHO avatar Aug 20 '24 20:08 trueNAHO

Changelog: v1

  • Commit Message
    • Add Link: tag to GitHub issue form documentation
    • Credit @danth as reviewer
  • Patch
    • Add installation method checkboxes
    • Add validations: required
    • Replace input version table with flake.lock content
    • Remove Description placeholder and update its description
    • Rename Bug Report to Bug
    • Rename .github/ISSUE_TEMPLATE/bug_report.yml file to .github/ISSUE_TEMPLATE/bug.yml

trueNAHO avatar Aug 21 '24 22:08 trueNAHO

would something like

  -type: checkboxes

    attributes:
      label: Is there an existing issue for this?
      description: Search [existing issues](https://github.com/danth/stylix/issues) to see if this issue has been raised before.

    options:
      -label: I have searched for an existing issue.
      required: true

be useful for avoiding duplicate issues?

in addition, i think i'm gonna write an FAQ or Common Issues section in the docs that would be good to ask them to read.

Flameopathic avatar Feb 25 '25 14:02 Flameopathic

would something like

  -type: checkboxes

    attributes:
      label: Is there an existing issue for this?
      description: Search [existing issues](https://github.com/danth/stylix/issues) to see if this issue has been raised before.

    options:
      -label: I have searched for an existing issue.
      required: true

be useful for avoiding duplicate issues?

We do not have that many duplicate issues. However, this could hopefully further reduce that number.

in addition, i think i'm gonna write an FAQ or Common Issues section in the docs that would be good to ask them to read.

Yes, an FAQ would be greatly appreciated. Currently, most Stylix limitations and plans to resolve them are only mentioned in GitHub issues and PRs, which is rather inconvenient to discover.

trueNAHO avatar Feb 27 '25 07:02 trueNAHO

Regarding an FAQ, it might also be good to have a Troubleshooting page with some common error messages.

danth avatar Mar 03 '25 09:03 danth

Superseding and merging this PR into https://github.com/danth/stylix/pull/921.

trueNAHO avatar Mar 10 '25 12:03 trueNAHO