Skip to content

[CHORE] Update issue templates to use a short description title only #524

@Miou-zora

Description

@Miou-zora

Problem Statement

The current issue templates prompt contributors to include a type prefix in the title (e.g. [BUG], [FEATURE], fix:, feat:). This is redundant since GitHub labels already convey the type of issue. It also adds unnecessary friction when creating an issue.

Proposed Solution

Update the issue templates so that the title field only asks for a short, clear description of the issue — no prefix required. The type is already communicated through GitHub labels (e.g. bug, enhancement, chore).

Example of a good title:

  • Crash when loading empty scene
  • Add support for multiple viewports
  • Cleanup unused dependencies in core module

Alternative Solutions

  • Keep the prefix format and document its mapping to labels — minimal effort but still adds noise to titles.

Use Cases

  • Use case 1: A contributor opens an issue and just writes what the problem or request is, without worrying about prefixes.
  • Use case 2: A maintainer reads the issue list with clean, descriptive titles, and uses label filters to sort by type.

Impact

  • Template/documentation change only — no changes to source code or CI workflows.
  • Existing open issues with the old format are not automatically renamed.
  • No breaking changes.

Implementation Details (optional)

  • Update .github/ISSUE_TEMPLATE/*.md to remove any title prefix placeholder and replace it with a prompt for a short description only.
  • Example placeholder: title: '' with a comment like # Short description of the issue — labels indicate the type.

Additional Context

N/A

Related Issues

  • N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    choreSomething related to the repository / GitHub

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions