Skip to content

Conversation

@harryswift01
Copy link
Contributor

Summary

This PR resolves inconsistencies across the GitHub issue templates by standardising the use of HTML comments and ensuring that instructional text is handled correctly in all issue options.

Changes

Standardise HTML comments in issue templates

  • Reviewed all GitHub issue templates for inconsistent or missing HTML comments.
  • Added or corrected HTML comments so that guidance text does not appear in created issues.
  • Aligned comment wording and structure across all templates for consistency.

Impact

  • Improved consistency and usability of GitHub issue templates.
  • Clearer guidance for contributors when selecting and completing issues.
  • No impact on application code or functionality.

@harryswift01 harryswift01 requested a review from jimboid January 20, 2026 10:16
@harryswift01 harryswift01 self-assigned this Jan 20, 2026
@harryswift01 harryswift01 added the documentation Improvements or additions to documentation label Jan 20, 2026
@harryswift01 harryswift01 linked an issue Jan 20, 2026 that may be closed by this pull request
Copy link
Member

@jimboid jimboid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Templated issues are an excellent addition. Many thanks for adding this.

@jimboid
Copy link
Member

jimboid commented Jan 20, 2026

I just posted in the zoom chat why these tests are failing.

@harryswift01 harryswift01 merged commit 6d0c9bf into main Jan 21, 2026
14 checks passed
@harryswift01 harryswift01 deleted the 251-docs-improve-readability-of-github-issues branch January 21, 2026 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Improve Readability of GitHub Issues

3 participants