feat: add GitHub issue templates for bug reports and feature requests#187
Open
Ayush2k02 wants to merge 1 commit intoneondatabase:mainfrom
Open
feat: add GitHub issue templates for bug reports and feature requests#187Ayush2k02 wants to merge 1 commit intoneondatabase:mainfrom
Ayush2k02 wants to merge 1 commit intoneondatabase:mainfrom
Conversation
Fixes neondatabase#185 Added comprehensive issue templates to improve bug reporting and feature request quality. This will help maintainers quickly understand and triage issues. Changes: - Created bug_report.yml with detailed fields for: - Bug description and reproduction steps - Expected vs actual behavior - Code samples with syntax highlighting - Runtime environment selection (Node.js, Workers, Edge, etc.) - Package and environment versions - Error logs and stack traces - Created feature_request.yml with fields for: - Problem description and motivation - Proposed solution - Alternative approaches considered - Use case explanation - Example API usage - Added config.yml with helpful links to: - Neon documentation - Discord community - Support resources Benefits: - Structured bug reports with all necessary information - Easier for maintainers to reproduce and fix issues - Better feature request clarity and context - Reduced back-and-forth for missing information - Links to appropriate resources for common questions
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #185
This PR adds comprehensive GitHub issue templates to improve the quality and consistency of bug reports and feature requests for the
@neondatabase/serverlesspackage.Added three files to
.github/ISSUE_TEMPLATE/:1.
bug_report.yml- Bug Report TemplateComprehensive form with fields for:
2.
feature_request.yml- Feature Request TemplateStructured form with fields for:
3.
config.yml- Issue Template ConfigurationProvides helpful links:
Also allows blank issues for edge cases.
Example
When users click "New Issue", they'll see:
These templates will be active once merged. You can preview them in the GitHub UI by: