-
Notifications
You must be signed in to change notification settings - Fork 6
Add technical tracking and task issue templates, tweak existing issue templates. #39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
8186a06
Add technical tracking and task issue templates, tweak existing issue…
rtibbles d4f8002
Add AI generation comment to all templates.
rtibbles 293fac7
Make implementation guidance more nuanced.
rtibbles ded5078
Add more metadata to issue templates
rtibbles File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| --- | ||
| name: Technical Task Issue | ||
| about: A single technical task, typically part of a tracking issue or product issue | ||
| --- | ||
|
|
||
| <!-- | ||
| Instructions: | ||
| - Fill in Overview, The Change, and Acceptance Criteria (required) | ||
| - Delete any optional sections you don't need | ||
| - Remove all instructional comments before submitting | ||
| --> | ||
|
|
||
| ## Overview | ||
|
|
||
| <!-- | ||
| Describe what needs to be done and why. | ||
| Keep it brief - a few sentences. | ||
| --> | ||
|
|
||
| **Complexity:** Low | Medium | High | ||
|
|
||
| ### Context | ||
|
|
||
| <!-- | ||
| OPTIONAL - Delete if not needed. | ||
|
|
||
| Provide background needed to understand the task: | ||
| - For bugs: current behavior, code snippets, error messages | ||
| - For frontend work: screenshots of current state | ||
| - For refactors: relevant existing implementation details | ||
|
|
||
| Do NOT provide the solution - equip the developer to find it. | ||
| --> | ||
|
|
||
| ### The Change | ||
|
|
||
| <!-- | ||
| Describe what needs to change and the general direction. | ||
| - For frontend new features: include screenshots/mockups of desired end state | ||
| - For backend work: describe the expected behavior, not the implementation | ||
|
|
||
| Focus on WHAT and WHY, not HOW. The developer determines the implementation. | ||
| --> | ||
|
|
||
| ### How to Get There | ||
|
|
||
| <!-- | ||
| OPTIONAL - Delete if not needed. | ||
|
|
||
| For frontend or user-facing changes: | ||
| - Navigation steps to reach the relevant UI | ||
| - Steps to reproduce a bug | ||
|
|
||
| For backend: | ||
| - How to trigger the relevant code path | ||
| --> | ||
|
|
||
| ### Out of Scope | ||
|
|
||
| <!-- | ||
| OPTIONAL - Delete if not needed. | ||
|
|
||
| Explicitly list what should NOT be changed as part of this task. | ||
| Helps prevent scope creep and keeps PRs focused. | ||
| --> | ||
|
|
||
| ### Acceptance Criteria | ||
|
|
||
| <!-- | ||
| Checklist of requirements for the task to be considered complete. | ||
| All items should be verifiable. | ||
|
|
||
| For frontend tasks, consider adding subsections: | ||
| #### General | ||
| #### Accessibility and i18n | ||
| #### Testing | ||
|
|
||
| For backend tasks, consider: | ||
| #### General | ||
| #### Testing | ||
| --> | ||
|
|
||
| - [ ] | ||
|
|
||
| ### Testing | ||
|
|
||
| <!-- | ||
| OPTIONAL - Delete if not needed. | ||
|
|
||
| Specific test commands or manual verification steps. | ||
| Only include if there are task-specific testing requirements | ||
| beyond what's in Acceptance Criteria. | ||
| --> | ||
|
|
||
| ### References | ||
|
|
||
| <!-- | ||
| OPTIONAL - Delete if not needed. | ||
|
|
||
| Links to documentation, code references, or relevant libraries. | ||
| --> | ||
|
|
||
| <!-- | ||
| AI DISCLOSURE: If this issue was written with AI assistance, add: | ||
| 🤖 This issue was written with AI assistance, under supervision, review and final edits by [@username] 🤖 | ||
| --> | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| name: Technical Tracking Issue | ||
| about: A parent issue that encompasses multiple related technical tasks | ||
| title: '' | ||
| --- | ||
|
|
||
| <!-- | ||
| Instructions: | ||
| - Fill in Overview and Scope (required) | ||
| - Delete any optional sections you don't need | ||
| - Remove all instructional comments before submitting | ||
| --> | ||
|
|
||
| ## Overview | ||
|
|
||
| <!-- | ||
| Describe what this tracking issue encompasses and why the work matters. | ||
| Keep it concise: 3-5 sentences covering the "what" and "why". | ||
| --> | ||
|
|
||
| ### Scope | ||
|
|
||
| <!-- | ||
| Define boundaries clearly. | ||
| - What's included in this tracking issue | ||
| - What's explicitly excluded | ||
| --> | ||
|
|
||
| ### Guidance | ||
|
|
||
| <!-- | ||
| OPTIONAL - Delete if not needed. | ||
| Include setup instructions, documentation links, or reference materials | ||
| that apply across all sub-tasks. Especially useful for community-facing projects. | ||
| --> | ||
|
|
||
| ### Strategy | ||
|
|
||
| <!-- | ||
| OPTIONAL - Delete if not needed. | ||
| Describe the high-level approach if it's non-obvious or requires coordination | ||
| across sub-tasks. Remove if the approach is straightforward. | ||
| --> | ||
|
|
||
| ### Testing Requirements | ||
|
|
||
| <!-- | ||
| OPTIONAL - Delete if not needed. | ||
| Only include if there's a unifying test strategy across sub-tasks. | ||
| Otherwise, leave testing guidance to individual task issues. | ||
| --> | ||
|
|
||
| <!-- | ||
| AI DISCLOSURE: If this issue was written with AI assistance, add: | ||
| 🤖 This issue was written with AI assistance, under supervision, review and final edits by [@username] 🤖 | ||
| --> |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally, definitely. In some cases, I've found it important to specify architecture. But perhaps it doesn't need to reflected in a template. We can chat about it more later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with this @MisRob -- sometimes specifying the implementation is important, although my suspicion is that at least part of this is to support AI written issues that are overly detailed. Is that right, @rtibbles. Maybe a small addition such as "add specific architectural constraints or considerations" could be enough?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, this was definitely biased by the tendency of LLMs to just write out the implementation, but I do think it goes overboard. Updating before merge.