Add issue templates and PR template with required fields#1309
Conversation
…on and reproduction steps Co-authored-by: xin3he <83260933+xin3he@users.noreply.github.com>
|
@copilot 如何预览改动后的效果 |
您可以通过以下方式预览 issue 模板效果： 方式1：PR 合并后在主分支预览
方式2：在当前 PR 分支预览
模板效果预览：
模板包含：
用户必须填写标记为 |
There was a problem hiding this comment.
Pull request overview
This PR adds structured GitHub issue templates to enforce submission requirements for bug reports and feature requests, addressing the previous lack of quality control for issue submissions.
Changes:
- Adds bug report and feature request templates with required fields for problem descriptions and reproduction steps
- Configures template settings to disable blank issues, ensuring all submissions use the structured templates
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
.github/ISSUE_TEMPLATE/bug_report.yml |
Bug report template requiring problem description and reproduction steps, with optional fields for environment, logs, and context |
.github/ISSUE_TEMPLATE/feature_request.yml |
Feature request template requiring feature description and motivation/use case, with optional fields for alternatives and context |
.github/ISSUE_TEMPLATE/config.yml |
Template configuration disabling blank issues and providing documentation/discussion links |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
How about adding a template for PR desc as well? Thanks! |
|
…plate Co-authored-by: xin3he <83260933+xin3he@users.noreply.github.com>
Added PR description template in commit 99db0c9. The template (
|
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: xin3he <83260933+xin3he@users.noreply.github.com> Signed-off-by: lvliang-intel <liang1.lv@intel.com>
Description
This PR adds structured GitHub issue templates that enforce submission requirements for bug reports and feature requests, plus a comprehensive pull request description template. The repository previously had no requirements for issue or PR submissions, allowing low-quality reports without essential information.
Type of Change
Related Issues
Relates to #
Changes Made
Issue Templates
bug_report.yml): Requires problem description and reproduction steps. Includes optional fields for environment, error logs, and context.feature_request.yml): Requires feature description and motivation/use case. Includes optional "Definition of Done" section for defining completion criteria with checklist format.config.yml): Disables blank issues, forcing users to use templates. Links to documentation and discussions.Pull Request Template
pull_request_template.md): Comprehensive template with structured sections for description, type of change, related issues, detailed changes, testing information, and quality checklist.When users create issues, they must now complete required fields before submission. The PR template automatically appears when creating new pull requests, ensuring consistent and complete PR descriptions.
Testing
Checklist
Additional Context
All YAML files validated successfully. Templates follow GitHub's issue form syntax and PR template conventions. Required fields are properly marked with
validations: required: true. These templates will improve the quality of contributions by ensuring essential information is provided.Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.