Skip to content

docs: improve github issue templates#4017

Merged
provinzkraut merged 2 commits intolitestar-org:mainfrom
tofran:improve-issue-templates
Feb 19, 2025
Merged

docs: improve github issue templates#4017
provinzkraut merged 2 commits intolitestar-org:mainfrom
tofran:improve-issue-templates

Conversation

@tofran
Copy link
Copy Markdown
Contributor

@tofran tofran commented Feb 19, 2025

Description

This simple pull request improves GitHub issues templates, as the BUG.yaml was quite frustating when I created #4016

Before:
Screenshot 2025-02-19 at 18 23 03

After:
Screenshot 2025-02-19 at 18 12 18

Summary of changes:

  • Changed image upload textarea to a WYSIWYG to allow hosting images on GitHub instead of forcing raw markdown.
  • To ensure consistency in the, changed JSON lists to YAML lists.
  • Improved descriptions and placeholders

@tofran tofran requested review from a team as code owners February 19, 2025 18:28
@github-actions github-actions bot added area/ci This PR involves changes to the CI/Infra size: small pr/external Triage Required 🏥 This requires triage labels Feb 19, 2025
@tofran tofran changed the title Improve GitHub issue templates docs: improve GitHub issue templates Feb 19, 2025
@tofran tofran changed the title docs: improve GitHub issue templates docs: improve github issue templates Feb 19, 2025
@github-actions
Copy link
Copy Markdown

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/4017

Copy link
Copy Markdown
Member

@provinzkraut provinzkraut left a comment

Choose a reason for hiding this comment

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

Thanks @tofran :)

@provinzkraut provinzkraut merged commit 61b6330 into litestar-org:main Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/ci This PR involves changes to the CI/Infra pr/external size: small Triage Required 🏥 This requires triage type/docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants