-
Notifications
You must be signed in to change notification settings - Fork 354
docs(github): update issue templates and triage workflow #2645
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,53 @@ | ||
| --- | ||
| name: Bug! | ||
| about: Create a report to help us squash the bugs | ||
| title: "<short bug description>" | ||
| labels: kind/bug | ||
| name: Bug Report | ||
| about: Report a defect, crash, or unexpected behavior | ||
| title: "<short description>" | ||
| type: Bug | ||
| assignees: "" | ||
| --- | ||
|
|
||
| **Describe the bug** | ||
| ## Description | ||
|
|
||
| A clear and concise description of what the bug is. | ||
|
|
||
| **Version affected** | ||
| ## Expected Behavior | ||
|
|
||
| Please include the version of the software that you are using. | ||
| (paste the output of the `version` command) | ||
| What you expected to happen. | ||
|
|
||
| **How To Reproduce** | ||
| ## Actual Behavior | ||
|
|
||
| Detailed steps to reproduce the behavior: | ||
| What actually happened instead. | ||
|
|
||
| 1. Go to '...' | ||
| 2. Click on '....' | ||
| 3. Scroll down to '....' | ||
| 4. See error | ||
| ## Steps to Reproduce | ||
|
|
||
| **Expectation** | ||
| Detailed steps to reproduce the bug: | ||
|
|
||
| A clear and concise description of what you expected to see/happen. | ||
| 1. | ||
| 2. | ||
| 3. | ||
|
|
||
| **Screenshots** | ||
| ## Environment | ||
|
|
||
| If applicable, add screenshots to help explain your problem. | ||
| Especially useful if the problem is visual (rendering issues etc.) or you're not totally sure how to explain the problem and need to show it to us | ||
| - **Docker Agent Version**: (output of `docker agent --version`) | ||
| - **OS & Terminal**: macOS / Linux / Windows + terminal app | ||
| - **Model Used**: (e.g., claude-opus-4-1, gpt-4, etc.) | ||
|
|
||
| **OS and Terminal type** | ||
| ## Error Output | ||
|
|
||
| Please include what OS and terminal you are using | ||
| If applicable, paste the full error message or stack trace: | ||
|
|
||
| **Additional context** | ||
| ``` | ||
| <error output> | ||
| ``` | ||
|
|
||
| Any other info you consider useful can be included here | ||
| ## Screenshots | ||
|
|
||
| If this is a visual issue (TUI rendering, output formatting, etc.), add screenshots. | ||
|
|
||
| ## Additional Context | ||
|
|
||
| Any other information that might help us debug: | ||
| - Recent changes you made to your agent config | ||
| - Tools or MCPs being used | ||
| - Whether this is a regression (used to work in a previous version) | ||
| - Links to related issues |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,49 @@ | ||
| --- | ||
| name: Feature! | ||
| about: Suggest a new feature you'd like to see | ||
| title: "<your feature>" | ||
| labels: kind/feature | ||
| name: Feature Request | ||
| about: Suggest a new feature or improvement | ||
| title: "<short description>" | ||
| type: Enhancement | ||
| assignees: "" | ||
| --- | ||
|
|
||
| **What you'd like to see** | ||
| ## Overview | ||
|
|
||
| Describe in as much detail as possible the feature you'd like to see. | ||
| Please limit this to a single small feature whenever possible to ease development and contribution efforts | ||
| Describe the feature or improvement you'd like to see. Be as specific as possible. | ||
|
|
||
| **Why you'd like to see it** | ||
| ## Motivation | ||
|
|
||
| Tell us why it's important for you. | ||
| `x` thing would help me do ... | ||
| `y` feature frustrates me. | ||
| `z` feature would get rid of these issues ... | ||
| Why is this important? What problem does it solve? | ||
|
|
||
| **Workarounds?** | ||
| Examples: | ||
| - "This would let me do..." | ||
| - "Currently, I have to work around this by..." | ||
| - "This is needed for..." | ||
|
|
||
| Are you using any workarounds at the moment? If so, tell us about them | ||
| ## Use Cases | ||
|
|
||
| **Additional context** | ||
| Describe concrete scenarios where this feature would help: | ||
|
|
||
| Any other info you consider useful can be included here | ||
| 1. | ||
| 2. | ||
| 3. | ||
|
|
||
| ## Proposed Solution | ||
|
|
||
| If you have ideas on how to implement this, describe them here. | ||
|
|
||
| Examples: | ||
| - New CLI flag: `--option value` | ||
| - New agent config field: `agents.root.new_field: value` | ||
| - New tool: `xyz_tool` | ||
|
|
||
| ## Alternatives | ||
|
|
||
| Are there any workarounds available currently? What are the alternatives? | ||
|
|
||
| ## Related Issues | ||
|
|
||
| Link any related issues or discussions. | ||
|
|
||
| ## Additional Context | ||
|
|
||
| Any other information relevant to this feature request. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,7 +19,7 @@ concurrency: | |
|
|
||
| jobs: | ||
| triage: | ||
| if: github.event.label.name == 'kind/bug' | ||
| if: github.event.issue.node_id != '' && github.event.issue.type == 'Bug' | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [HIGH] Triage workflow condition uses invalid The workflow trigger is if: github.event.issue.node_id != '' && github.event.issue.type == 'Bug'
Suggested fix: Either keep label-based triggering (add back a |
||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 15 | ||
| env: | ||
|
|
||
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.
[MEDIUM] Nightly scanner instructions say issue type is set separately, but
gh issue createlacks--typeflagThe updated instructions state:
However, the
gh issue createcommand shown in this diff does not include--type:The
ghCLI supports--type <type>for issue type assignment. Without it, issues created by the nightly scanner will have no native type set, making them invisible to any type-based triage automation (including the updated auto-triage workflow). The instruction is misleading because it implies the type will be handled, but the actual command doesn't do it.Suggested fix: Add
--type "Bug"(for security/bug categories) to thegh issue createcommand, for example: