mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-09-20 22:02:19 +03:00
bug_report.yml and feature_request.yml prefilled `[BUG] ` / `[Feature] ` while CONTRIBUTING.md documents Conventional Commits with a scope list, so reporters who followed the template verbatim had their title renamed by triage. The templates now teach the convention instead: `fix(): ` and `feat(): `. Each form gains one intro line pointing at the commit-message section of CONTRIBUTING.md, where the scope list lives. `test_coverage_task.yml` is left untouched, as its `[Coverage] ` prefix is not part of the convention. Refs #13688
174 lines
4.6 KiB
YAML
174 lines
4.6 KiB
YAML
name: Bug Report
|
|
description: Report a bug or unexpected behavior in OmniRoute
|
|
title: "fix(): "
|
|
labels: ["bug"]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for taking the time to report a bug. Please fill out the sections below so we can reproduce and fix the issue.
|
|
|
|
The title is prefilled as `fix(): ` to match the [Conventional Commits](https://github.com/diegosouzapw/OmniRoute/blob/main/CONTRIBUTING.md#commit-messages) convention — pick a scope from the list documented there (e.g. `providers`, `resilience`, `dashboard`, `api`).
|
|
|
|
- type: input
|
|
id: version
|
|
attributes:
|
|
label: OmniRoute Version
|
|
description: "Run `omniroute --version` or check the left sidebar in the dashboard."
|
|
placeholder: "e.g. 3.7.9"
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: install-method
|
|
attributes:
|
|
label: Installation Method
|
|
options:
|
|
- npm (global)
|
|
- Docker / Docker Compose
|
|
- Electron desktop app
|
|
- Built from source
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: os
|
|
attributes:
|
|
label: Operating System
|
|
options:
|
|
- Windows
|
|
- macOS
|
|
- Linux
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: os-version
|
|
attributes:
|
|
label: OS Version
|
|
placeholder: "e.g. Windows 11 25H2, macOS 26.5, Ubuntu 26.04"
|
|
validations:
|
|
required: false
|
|
|
|
- type: input
|
|
id: node-version
|
|
attributes:
|
|
label: Node.js Version
|
|
description: "Run `node --version`. Skip if using Docker."
|
|
placeholder: "e.g. 24.15.0"
|
|
validations:
|
|
required: false
|
|
|
|
- type: input
|
|
id: provider
|
|
attributes:
|
|
label: Provider(s) Involved
|
|
description: "Which AI provider(s) does this affect?"
|
|
placeholder: "e.g. Antigravity, OpenRouter, Ollama, Qwen"
|
|
validations:
|
|
required: false
|
|
|
|
- type: input
|
|
id: model
|
|
attributes:
|
|
label: Model(s) Involved
|
|
placeholder: "e.g. claude-opus-4-7, gpt-5.5, gemini-3.1-pro"
|
|
validations:
|
|
required: false
|
|
|
|
- type: input
|
|
id: client-tool
|
|
attributes:
|
|
label: Client Tool
|
|
description: "Which tool are you using OmniRoute with?"
|
|
placeholder: "e.g. Claude Code, Cursor, Roo Code, OpenClaw, Gemini CLI, cURL"
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: description
|
|
attributes:
|
|
label: Description
|
|
description: "A clear description of what the bug is."
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: steps
|
|
attributes:
|
|
label: Steps to Reproduce
|
|
description: "Step-by-step instructions to reproduce the behavior."
|
|
placeholder: |
|
|
1. Go to '...'
|
|
2. Click on '...'
|
|
3. See error
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: expected
|
|
attributes:
|
|
label: Expected Behavior
|
|
description: "What did you expect to happen?"
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: actual
|
|
attributes:
|
|
label: Actual Behavior
|
|
description: "What actually happened?"
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: test-impact
|
|
attributes:
|
|
label: Test Impact
|
|
description: "What automated test coverage should exist for this bug?"
|
|
options:
|
|
- Needs a new unit test
|
|
- Needs a new integration test
|
|
- Needs a new e2e test
|
|
- Existing automated test already fails
|
|
- Unsure
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: logs
|
|
attributes:
|
|
label: Error Logs / Output
|
|
description: "Paste any relevant error messages, logs, or terminal output. This will be automatically formatted as code."
|
|
render: shell
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: screenshots
|
|
attributes:
|
|
label: Screenshots
|
|
description: "If applicable, add screenshots to help explain the problem. Please also include the text of any error messages above — screenshots alone are not searchable."
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: additional
|
|
attributes:
|
|
label: Additional Context
|
|
description: "Any other context about the problem (e.g. proxy config, number of accounts, network setup)."
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: validation-plan
|
|
attributes:
|
|
label: Validation Plan
|
|
description: "Which commands or tests should prove this bug is fixed?"
|
|
placeholder: |
|
|
Example:
|
|
- node --import tsx --test tests/unit/my-file.test.ts
|
|
- npm run test:coverage
|
|
validations:
|
|
required: false
|