Conversation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive set of GitHub issue templates, including Bug Report, Chore, Enhancement, Feature Request, Research Task, and Sub-Issue. The feedback focuses on improving the sub-issue.md template by ensuring naming consistency, adding default labels, and replacing escaped bracket placeholders with angle brackets to match the style of other templates and improve the user experience.
| @@ -0,0 +1,36 @@ | |||
| --- | |||
| name: Sub-Issue Template | |||
There was a problem hiding this comment.
To maintain consistency with the other templates in this directory (e.g., Chore, Enhancement, Research Task), consider removing the word Template from the name.
| name: Sub-Issue Template | |
| name: Sub-Issue |
| name: Sub-Issue Template | ||
| about: Use this for tracking sub-tasks under major issues | ||
| title: "[Sub-Issue] " | ||
| labels: |
There was a problem hiding this comment.
The labels field is currently empty, which deviates from the pattern established in the other five templates (bug, chore, enhancement, feature, research). Adding a default label like sub-issue or task will help in automatically categorizing these issues and improving repository organization.
| labels: | |
| labels: sub-issue |
| assignees: '' | ||
| --- | ||
|
|
||
| ### Sub-Issue: \[Brief Description of the Sub-Task] |
There was a problem hiding this comment.
The use of escaped brackets \[...\] for placeholders is inconsistent with the rest of the file (e.g., line 23) and other templates like feature.md. These backslashes will persist in the text area when a user creates an issue, requiring manual cleanup. It is recommended to use angle brackets <...> for placeholders to provide a better user experience and maintain consistency.
| ### Sub-Issue: \[Brief Description of the Sub-Task] | |
| ### Sub-Issue: <Brief Description of the Sub-Task> |
|
|
||
| ### What needs to be done | ||
|
|
||
| \[Clearly describe the scope and purpose of this sub-issue. If applicable, mention relevant existing code, its limitations, and what the outcome of this sub-issue should achieve.] |
There was a problem hiding this comment.
Avoid using escaped brackets \[...\] for placeholders here as well. Using <...> is more consistent with the other templates in this PR and prevents unnecessary characters from being left in the issue body for the user to delete.
| \[Clearly describe the scope and purpose of this sub-issue. If applicable, mention relevant existing code, its limitations, and what the outcome of this sub-issue should achieve.] | |
| <Clearly describe the scope and purpose of this sub-issue. If applicable, mention relevant existing code, its limitations, and what the outcome of this sub-issue should achieve.> |
|
|
||
| ### Why this is needed | ||
|
|
||
| \[Explain why the change improves maintainability, reusability, or correctness. Focus on long-term benefits like reducing duplication, simplifying onboarding, or decoupling service responsibilities.] |
There was a problem hiding this comment.
Avoid using escaped brackets \[...\] for placeholders. Using <...> is more consistent with the other templates and ensures a cleaner interface for the person filling out the issue.
| \[Explain why the change improves maintainability, reusability, or correctness. Focus on long-term benefits like reducing duplication, simplifying onboarding, or decoupling service responsibilities.] | |
| <Explain why the change improves maintainability, reusability, or correctness. Focus on long-term benefits like reducing duplication, simplifying onboarding, or decoupling service responsibilities.> |
1 participant
Summary
.github/ISSUE_TEMPLATE/: bug, chore, enhancement, feature, research, and sub-issueTest plan
🤖 Generated with Claude Code