Conversation
- Bug reports - Feature requests - General issues - Pull requests
There was a problem hiding this comment.
Pull request overview
This PR adds Git and GitHub templates to standardize project workflows and contributions. It introduces a commit message template following conventional commit format, a pull request template with a basic checklist, and three issue templates for bug reports, feature requests, and general issues.
Changes:
- Added
.gitmessagetemplate defining conventional commit format with types (feat, fix, docs, style, refactor, perf, test, chore) - Added
.github/PULL_REQUEST_TEMPLATE.mdwith description section and checklist for tests, documentation, and review readiness - Added three issue templates: bug_report.md, feature_request.md, and general_issue.md
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| .gitmessage | Provides conventional commit message template with type, body, and footer sections |
| .github/PULL_REQUEST_TEMPLATE.md | Standard PR template with description and contribution checklist |
| .github/ISSUE_TEMPLATE/bug_report.md | Template for bug reports with reproduction steps and expected/actual behavior |
| .github/ISSUE_TEMPLATE/feature_request.md | Template for feature requests with description, motivation, and context |
| .github/ISSUE_TEMPLATE/general_issue.md | Minimal general-purpose issue template |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,17 @@ | |||
| # Bug Report | |||
There was a problem hiding this comment.
GitHub Issue Templates best practice is to include YAML frontmatter to configure template metadata. The frontmatter should include at minimum a 'name' field (the display name shown in GitHub UI) and an 'about' field (a brief description). For example:
name: Bug Report
about: Create a report to help us improve
Without this metadata, GitHub will not properly display these templates in the issue creation UI dropdown, limiting their usability.
| @@ -0,0 +1,10 @@ | |||
| # Feature Request | |||
There was a problem hiding this comment.
GitHub Issue Templates best practice is to include YAML frontmatter to configure template metadata. The frontmatter should include at minimum a 'name' field (the display name shown in GitHub UI) and an 'about' field (a brief description). For example:
name: Feature Request
about: Suggest an idea for this project
Without this metadata, GitHub will not properly display these templates in the issue creation UI dropdown, limiting their usability.
| @@ -0,0 +1,4 @@ | |||
| # General Issue | |||
There was a problem hiding this comment.
GitHub Issue Templates best practice is to include YAML frontmatter to configure template metadata. The frontmatter should include at minimum a 'name' field (the display name shown in GitHub UI) and an 'about' field (a brief description). For example:
name: General Issue
about: General issue template
Without this metadata, GitHub will not properly display these templates in the issue creation UI dropdown, limiting their usability.
| Please include a summary of the changes and the related issue. | ||
|
|
||
| ## Checklist | ||
| - [ ] Tests added/updated |
There was a problem hiding this comment.
The pull request template should reference the project's testing practices. Looking at the README (lines 27-46 and 56-66), this project emphasizes running 'make check-coverage' before submitting PRs. The checklist should specifically mention 'make check-coverage' rather than the generic 'Tests added/updated', to align with established project conventions.
| - [ ] Tests added/updated | |
| - [ ] Tests added/updated and `make check-coverage` has been run |
| Describe your issue here. | ||
|
|
There was a problem hiding this comment.
The general issue template is too minimal to be useful. It provides no structure or guidance to users, which can lead to incomplete or poorly formatted issues. Consider either removing this template in favor of the specific templates (bug_report, feature_request) or enhancing it with sections similar to the other templates (e.g., Description, Context, Additional Information).
| Describe your issue here. | |
| <!-- Please fill out as much of this template as possible. --> | |
| ## Summary | |
| <!-- Briefly describe the issue in 1–3 sentences. --> | |
| ## Context | |
| - [ ] Question | |
| - [ ] Discussion | |
| - [ ] Documentation | |
| - [ ] Other (please describe): | |
| ## Detailed Description | |
| <!-- Provide a clear and concise description of the issue. What are you trying to accomplish? What is happening instead? --> | |
| ## Steps to Reproduce (if applicable) | |
| 1. | |
| 2. | |
| 3. | |
| ## Expected Behavior | |
| <!-- What did you expect to happen? --> | |
| ## Actual Behavior | |
| <!-- What actually happened? Include any error messages if relevant. --> | |
| ## Environment (if relevant) | |
| - Version/Commit: | |
| - Operating System: | |
| - Runtime/Tooling (e.g., Node, Python, Java, CLI versions): | |
| ## Additional Information | |
| <!-- Add logs, screenshots, links to related issues/PRs, or any other context. --> |
| @@ -0,0 +1,12 @@ | |||
| Subject: <type>: <short summary> | |||
There was a problem hiding this comment.
The commit message template format is unclear. The line starts with "Subject:" which is not standard for conventional commits. According to conventional commit format, the first line should directly be the commit message in the format <type>: <short summary> without the "Subject:" prefix. This prefix will be included in actual commit messages if users follow the template literally, which is not desirable.
| Subject: <type>: <short summary> | |
| <type>: <short summary> |
No description provided.