Add issue templates for bug reports and feature requests, and include… #9
Conversation
… a Code of Conduct and Contributing guidelines
There was a problem hiding this comment.
Pull Request Overview
This PR establishes foundational community documentation for the mpzsql project by adding issue templates and contribution guidelines to improve collaboration and standardize community interactions.
- Added GitHub issue templates for bug reports and feature requests to standardize issue reporting
- Created community guidelines including a Code of Conduct and contribution instructions
- Established project standards for code style, testing, and documentation
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
.github/ISSUE_TEMPLATE/bug_report.md |
Bug report template with structured fields for reproducible issue reporting |
.github/ISSUE_TEMPLATE/feature_request.md |
Feature request template to guide structured enhancement proposals |
CODE_OF_CONDUCT.md |
Community behavioral guidelines based on Contributor Covenant |
CONTRIBUTING.md |
Contribution guidelines covering workflow, code style, testing, and submission process |
| name: Bug Report | ||
| about: Create a report to help us improve | ||
| title: '' | ||
| labels: bug | ||
| assignees: '' | ||
|
|
There was a problem hiding this comment.
GitHub issue template frontmatter should be enclosed in YAML frontmatter delimiters (---). Add '---' at the beginning of the file before line 1.
| name: Bug Report | |
| about: Create a report to help us improve | |
| title: '' | |
| labels: bug | |
| assignees: '' | |
| --- | |
| name: Bug Report | |
| about: Create a report to help us improve | |
| title: '' | |
| labels: bug | |
| assignees: '' |
Copilot uses AI. Check for mistakes.
| name: Feature Request | ||
| about: Suggest an idea for this project | ||
| title: '' | ||
| labels: enhancement | ||
| assignees: '' | ||
|
|
There was a problem hiding this comment.
GitHub issue template frontmatter should be enclosed in YAML frontmatter delimiters (---). Add '---' at the beginning of the file before line 1.
| name: Feature Request | |
| about: Suggest an idea for this project | |
| title: '' | |
| labels: enhancement | |
| assignees: '' | |
| --- | |
| name: Feature Request | |
| about: Suggest an idea for this project | |
| title: '' | |
| labels: enhancement | |
| assignees: '' |
Copilot uses AI. Check for mistakes.
| If applicable, add screenshots to help explain your problem. | ||
|
|
||
| **Desktop (please complete the following information):** | ||
| - OS: [e.g. iOS] |
There was a problem hiding this comment.
The OS example 'iOS' is inconsistent with the Desktop section context. Consider using 'Windows, macOS, Linux' as examples for desktop operating systems.
| - OS: [e.g. iOS] | |
| - OS: [e.g. Windows, macOS, Linux] |
Copilot uses AI. Check for mistakes.
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
Add issue templates for bug reports and feature requests, and include…
1 participant
This pull request introduces foundational project documentation and issue templates to improve community engagement and streamline contribution processes. The most important changes include adding issue templates for bug reports and feature requests, creating a
CODE_OF_CONDUCT.mdfile, and adding aCONTRIBUTING.mdfile to guide contributors.Issue Templates:
.github/ISSUE_TEMPLATE/bug_report.md)..github/ISSUE_TEMPLATE/feature_request.md).Community Guidelines:
CODE_OF_CONDUCT.mdfile based on the Contributor Covenant to establish behavioral expectations and ensure a welcoming environment for all contributors.Contribution Guidelines:
CONTRIBUTING.mdfile with detailed instructions on reporting issues, coding style, testing, and submitting pull requests to encourage high-quality contributions.