Skip to content

[Docs]: Improve Readability of GitHub Issues #251

@harryswift01

Description

@harryswift01

Documentation Update

Some sections of the GitHub issue templates contain inconsistent or missing HTML comments. These comments should be standardised so that all issue templates follow the same structure and guidance.

Why Is This Needed?

Consistency across issue templates improves usability and contributor experience. Standardised comments make templates easier to understand, easier to maintain, and reduce confusion when users create new issues.

Suggested Changes

  • Review all existing GitHub issue templates.
  • Ensure that every non-heading line intended as guidance is wrapped in HTML comments (<!-- -->).
  • Align comment wording and structure so it is consistent across all templates.
  • Remove any visible instructional text that should not appear in created issues.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions