Skip to content

Add GitHub issue templates (bug report & feature request) #265

Description

@shenxianpeng

Context

This repo has no .github/ISSUE_TEMPLATE/, so new issues start blank and often miss key details (pre-commit rev, hook id, args, clang tool version, OS). Our sibling repo cpp-linter-action already uses YAML issue forms — we can mirror that style, adapted to a pre-commit context.

Task

Add three files under .github/ISSUE_TEMPLATE/:

  • bug-report.yml — fields for: .pre-commit-config.yaml snippet, hook id (clang-format/clang-tidy), rev and --version used, OS, and expected vs. actual behavior.
  • feature-request.yml — problem/motivation + proposed solution.
  • config.ymlblank_issues_enabled: false and contact links to the docs and Discussions.

The cpp-linter-action templates are a good starting point — copy their structure and adjust the fields for pre-commit usage (drop GitHub-Action-specific inputs).

Acceptance criteria

  • "New issue" shows the two forms plus the contact links.
  • Fields are relevant to pre-commit usage (not GitHub-Action fields).

Getting started

GitHub's issue-forms syntax. No code involved.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions