litestar-org / litestar-org/project-template
docs: enrich issue template chooser with contact links
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 13
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
## Context
The current `.github/ISSUE_TEMPLATE/config.yaml` only contains `blank_issues_enabled: false`. PR #16 enriched it with `contact_links` (docs, website, Discord) to route people to the right place before opening an issue.
## ⚠️ Note on PR #16's version
PR #16 wrote `blank_lines_enabled: true` — this key is **invalid**. GitHub only recognizes [`blank_issues_enabled`](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser), so that line is silently ignored (and defaults blank issues back to *enabled*). We should:
- Keep the correct key `blank_issues_enabled` (proposal: keep `false` to preserve current behavior)
- Add the `contact_links` block
- Use the modern `discord.gg/litestar` invite
## Proposed tasks
- [ ] Add `contact_links` (Litestar Documentation, Litestar Website, Discord) to `config.yaml`
- [ ] Preserve `blank_issues_enabled: false`
- [ ] (Optional follow-up) update the stale `discord.gg/MmcwxztmQb` invite in `pyproject.toml`
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open .github/ISSUE_TEMPLATE/config.yaml and compare its current setting with the contact_links example described in the issue. Preserve blank_issues_enabled: false, add links for Litestar Documentation, Litestar Website, and the modern Discord invite, then verify the YAML structure and link targets. The pyproject.toml invite update is optional follow-up work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100