sql-formatter-org / sql-formatter-org/sql-formatter
Feature Request: Reduce issues with simple misconfigurations
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.9k
- Forks
- 456
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 3
Description
Describe the Feature
I often see issues being posted here where there was a simple misconfiguration, eg:
This takes time and focus to reply to, although a lot of them can be resolved by just using the correct language.
Maybe there would be some ways to reduce these issues, eg:
- Include an explicit step in the issue template
- While we're at it, we could convert to an issue form (example in Next.js bug report issue template)
- Consider adding a bot that replies to issues
- Zod uses Dosu bot for this (and has good things to say about it), which answers based on docs and past issues
- Require a reproduction
- Add a way to pass in code and options via URL to the demo / playground website - similar to Prettier Playground or TypeScript Playground
- Require a demo/playground link in the issue
Why do you want this feature?
Already included above
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
Start with .github/ISSUE_TEMPLATE/formatting-bug-report.md and compare it with the linked Next.js issue-form example. Review the demo/playground website and the cited Prettier and TypeScript playgrounds, then clarify which proposal is in scope; completion cannot be defined until maintainers choose between template changes, bot support, and reproduction links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, typescript
- Domain
- developer-experience, tooling, web-dev
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100