mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-09-20 13:52:28 +03:00
57d7e861d1
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
99 lines
2.9 KiB
YAML
99 lines
2.9 KiB
YAML
name: Feature Request
|
|
description: Suggest a new feature or improvement for OmniRoute
|
|
title: "feat(): "
|
|
labels: ["enhancement"]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for suggesting a feature! Please describe the problem you're trying to solve and how you'd like it to work.
|
|
|
|
The title is prefilled as `feat(): ` 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: textarea
|
|
id: problem
|
|
attributes:
|
|
label: Problem / Use Case
|
|
description: "What problem does this feature solve? Why do you need it?"
|
|
placeholder: "I'm trying to ... but currently ..."
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: solution
|
|
attributes:
|
|
label: Proposed Solution
|
|
description: "How would you like this to work?"
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: alternatives
|
|
attributes:
|
|
label: Alternatives Considered
|
|
description: "Have you considered any workarounds or alternative approaches?"
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: acceptance
|
|
attributes:
|
|
label: Acceptance Criteria
|
|
description: "Describe the concrete behaviors or outcomes that should be validated before this is considered done."
|
|
placeholder: |
|
|
Example:
|
|
- API route returns 200 with valid payload
|
|
- Unit coverage added for the new branch
|
|
- Existing integrations remain green
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: area
|
|
attributes:
|
|
label: Area
|
|
description: "Which part of OmniRoute does this relate to?"
|
|
multiple: true
|
|
options:
|
|
- Dashboard / UI
|
|
- Proxy / Routing
|
|
- Provider Support
|
|
- CLI Tools Integration
|
|
- OAuth / Authentication
|
|
- Analytics / Usage Tracking
|
|
- Docker / Deployment
|
|
- Documentation
|
|
- Other
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: provider
|
|
attributes:
|
|
label: Related Provider(s)
|
|
description: "If this relates to specific providers, list them."
|
|
placeholder: "e.g. Antigravity, OpenRouter, Ollama"
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: additional
|
|
attributes:
|
|
label: Additional Context
|
|
description: "Any other context, mockups, or references."
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: test-plan
|
|
attributes:
|
|
label: Expected Test Plan
|
|
description: "Which automated tests or coverage changes should accompany this work?"
|
|
placeholder: |
|
|
Example:
|
|
- Add unit tests for open-sse/services/combo.ts
|
|
- Extend integration coverage for /api/v1/models
|
|
- Keep npm run test:coverage at 60%+
|
|
validations:
|
|
required: false
|