Skip to content

Commit bf714b3

Browse files
committed
ci: add issue templates (bug report + feature request) and config
.github/ISSUE_TEMPLATE/: - bug_report.yml: structured YAML form requesting Windows/WSL/hardware details, OVMS logs, and a redacted .env. Includes confirmation checkboxes for 'no secrets in logs' and 'read CONTRIBUTING.md'. - feature_request.yml: problem/proposal/alternatives + scope dropdown. - config.yml: disables blank issues; surfaces security advisories and Discussions as alternative contact links.
1 parent 758679f commit bf714b3

3 files changed

Lines changed: 163 additions & 0 deletions

File tree

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
name: 🐛 Bug report
2+
description: Something that should work and doesn't.
3+
title: "[bug] "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to file a bug report.
10+
11+
Before submitting, please:
12+
- Make sure you're on the latest `main`.
13+
- Check existing issues to avoid duplicates.
14+
- **Do not paste secrets** (HF_TOKEN, API keys, personal data) in logs.
15+
16+
- type: textarea
17+
id: what-happened
18+
attributes:
19+
label: What happened?
20+
description: A clear, concise description. Include the actual error message.
21+
placeholder: e.g. "OVMS reports 'USM Host allocation failed' when loading the second model."
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: expected
27+
attributes:
28+
label: What did you expect to happen?
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: steps
34+
attributes:
35+
label: Steps to reproduce
36+
description: Numbered steps. Pretend the reader is starting from a fresh checkout.
37+
placeholder: |
38+
1. `cp .env.example .env` and set HF_TOKEN.
39+
2. `make models`
40+
3. `make up`
41+
4. `make smoke`
42+
5. Observe error in `make logs`.
43+
validations:
44+
required: true
45+
46+
- type: input
47+
id: windows
48+
attributes:
49+
label: Windows version
50+
description: Settings → System → About → "Specifications" → "Version" + "OS build"
51+
placeholder: Windows 11 Pro 24H2 (26100.2454)
52+
validations:
53+
required: true
54+
55+
- type: input
56+
id: wsl
57+
attributes:
58+
label: WSL version + RAM allocated
59+
description: From PowerShell `wsl -l -v` and `wsl --version`. From WSL `free -h`.
60+
placeholder: WSL 2.5.10 / Ubuntu-24.04 / 26 GiB allocated
61+
validations:
62+
required: true
63+
64+
- type: input
65+
id: hardware
66+
attributes:
67+
label: CPU model + iGPU
68+
description: e.g. "Core Ultra 7 258V / Arc 140V". Also `ls /dev/dri` and `ls /dev/dxg` output.
69+
placeholder: Core Ultra 7 258V / Arc 140V — /dev/dri/{card0,renderD128} present
70+
validations:
71+
required: true
72+
73+
- type: textarea
74+
id: ovms-logs
75+
attributes:
76+
label: OVMS logs
77+
description: Output of `docker compose logs ovms --tail=200`. Redact anything that looks like a secret.
78+
render: shell
79+
80+
- type: textarea
81+
id: env
82+
attributes:
83+
label: Relevant .env (no secrets)
84+
description: Paste your `.env` with `HF_TOKEN` redacted. Helps spot misconfig.
85+
render: dotenv
86+
87+
- type: checkboxes
88+
id: confirm
89+
attributes:
90+
label: Confirmations
91+
options:
92+
- label: I removed secrets/tokens from the logs and `.env` above.
93+
required: true
94+
- label: I've read [CONTRIBUTING.md](https://github.com/cartesiosson/openvino-agent-stack/blob/main/CONTRIBUTING.md).
95+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🔒 Security vulnerability
4+
url: https://github.com/cartesiosson/openvino-agent-stack/security/advisories/new
5+
about: Report security issues privately via GitHub Security Advisories. Don't open a public issue with exploit details.
6+
- name: 💬 Questions / discussion
7+
url: https://github.com/cartesiosson/openvino-agent-stack/discussions
8+
about: Open a Discussion for questions, ideas or "how do I…" — issues are for bugs and concrete feature requests.
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: ✨ Feature request
2+
description: Suggest a new tool, pipeline, model or improvement.
3+
title: "[feat] "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for the suggestion. This project stays small and focused, so
10+
not every request will be merged — but every reasonable one will be
11+
discussed.
12+
13+
- type: textarea
14+
id: problem
15+
attributes:
16+
label: What problem does this solve?
17+
description: Describe the user pain. Not the proposed solution yet.
18+
placeholder: e.g. "Open WebUI doesn't support drag-and-drop of multiple images at once."
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: proposal
24+
attributes:
25+
label: Proposed change
26+
description: What would you add/change/remove? Sketch the design if you can.
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: alternatives
32+
attributes:
33+
label: Alternatives considered
34+
description: Other ways to solve the same problem and why you ruled them out.
35+
36+
- type: dropdown
37+
id: scope
38+
attributes:
39+
label: Where does this change live?
40+
multiple: true
41+
options:
42+
- docker-compose.yml
43+
- OVMS config / graph.pbtxt
44+
- Pipelines (ReAct agent)
45+
- Open WebUI tools
46+
- SearXNG
47+
- scripts/ (model conversion)
48+
- Docs / README
49+
- CI
50+
- Other
51+
52+
- type: checkboxes
53+
id: confirm
54+
attributes:
55+
label: Confirmations
56+
options:
57+
- label: I've checked existing issues and this isn't a duplicate.
58+
required: true
59+
- label: I'm willing to discuss / iterate on the design before code is written.
60+
required: false

0 commit comments

Comments
 (0)