ci: add github templates #3
Merged
Conversation
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
Closed
3 tasks
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces standardized GitHub templates for issues and pull requests to improve collaboration and ensure consistent information capture across bug reports, feature requests, tasks, and PRs.
Key Changes:
- Added YAML-based issue templates for bug reports, feature requests, and tasks with structured fields and validation
- Introduced a markdown pull request template with standard sections for description, testing, and checklists
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
.github/pull_request_template.md |
Provides standardized PR structure with description, related issue, change type, testing details, and checklist |
.github/ISSUE_TEMPLATE/task.yml |
Defines task template with summary, details, subtasks, notes, and pre-work checklist |
.github/ISSUE_TEMPLATE/feature_request.yml |
Structures feature requests with problem statement, solution, alternatives, and confirmation checklist |
.github/ISSUE_TEMPLATE/bug_report.yml |
Guides bug reporting with reproduction steps, expected/actual behavior, logs, environment, and pre-checks |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
✅ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This pull request introduces standardized templates for issues and pull requests in the
.githubdirectory. These templates will help ensure that bug reports, feature requests, tasks, and pull requests are well-structured and provide all necessary information for efficient triage and collaboration.Issue and Pull Request Template Additions:
Bug Report, Feature Request, and Task Templates:
.github/ISSUE_TEMPLATE/bug_report.ymlto guide users in reporting API bugs, including required details like steps to reproduce, expected/actual behavior, environment, and pre-checks..github/ISSUE_TEMPLATE/feature_request.ymlto structure feature requests with problem statements, proposed solutions, alternatives, and a checklist to avoid duplicates..github/ISSUE_TEMPLATE/task.ymlfor development and maintenance tasks, including summary, details, subtasks, notes, and a pre-work checklist.Pull Request Template:
.github/pull_request_template.mdto standardize pull request submissions, ensuring contributors provide a description, related issue, type of change, testing details, and a checklist for best practices.Related Issue
Closes #2
Type of Change
How Has This Been Tested?
Not applicable
Checklist