Skip to content

docs: enrich issue template chooser with contact links - #31

Open
hasansezertasan wants to merge 1 commit into
mainfrom
docs/issue-template-contact-links
Open

docs: enrich issue template chooser with contact links#31
hasansezertasan wants to merge 1 commit into
mainfrom
docs/issue-template-contact-links

Conversation

@hasansezertasan

@hasansezertasan hasansezertasan commented Jul 22, 2026

Copy link
Copy Markdown
Member

Description

Adds a contact_links block to .github/ISSUE_TEMPLATE/config.yaml so the issue chooser points users to Documentation, the Website, and Discord before they open an issue.

Adapted from #16, with two corrections:

  • Fixed the config key. Litestarification #16 used blank_lines_enabled: true, which is not a valid GitHub key (only blank_issues_enabled is recognized) — it was silently ignored and would have defaulted blank issues back to enabled. This PR keeps the correct blank_issues_enabled: false, preserving current behavior.
  • Modern Discord invite (discord.gg/litestar).

Validated as parseable YAML with the expected keys.

Closes

Summary by Sourcery

Documentation:

  • Update issue template configuration to surface documentation, website, and Discord contact options in the issue chooser.

@hasansezertasan hasansezertasan added the documentation Improvements or additions to documentation label Jul 22, 2026
@sourcery-ai

sourcery-ai Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds GitHub issue template contact links while preserving the existing behavior of disallowing blank issues.

File-Level Changes

Change Details Files
Introduce contact links in the GitHub issue template chooser to direct users to documentation, website, and Discord before filing issues.
  • Keeps blank issue behavior unchanged with blank_issues_enabled: false.
  • Adds a contact_links section configured with three entries: Litestar Documentation, Litestar Website, and Discord.
  • Uses the modern Discord invite URL format (discord.gg/litestar).
  • Ensures the YAML structure matches GitHub’s expected issue template config schema.
.github/ISSUE_TEMPLATE/config.yaml

Assessment against linked issues

Issue Objective Addressed Explanation
#30 Add contact_links (Litestar Documentation, Litestar Website, Discord) to .github/ISSUE_TEMPLATE/config.yaml so the issue template chooser routes users appropriately before opening an issue.
#30 Preserve blank_issues_enabled: false in .github/ISSUE_TEMPLATE/config.yaml while adding the new configuration.
#30 Update the stale discord.gg/MmcwxztmQb invite in pyproject.toml to the modern discord.gg/litestar invite. The PR only modifies .github/ISSUE_TEMPLATE/config.yaml and does not change pyproject.toml, so any outdated Discord invite there remains unchanged.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Add contact_links (Litestar Documentation, Litestar Website, Discord)
to the issue template chooser so users are routed to the right place
before opening an issue. Keeps blank_issues_enabled: false.

Adapted from #16, correcting the invalid
blank_lines_enabled key and using the current discord.gg/litestar invite.

Closes #30
@hasansezertasan
hasansezertasan force-pushed the docs/issue-template-contact-links branch from 0c295e4 to 0166cb5 Compare July 26, 2026 12:23
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: enrich issue template chooser with contact links

2 participants