feat: add issue templates
- commit
- c7ca5aedfc5148849b494bfb90ea8a2119999c16
- author
- Neil Vallecer · · 2026-06-01 18:41 UTC
- parent
- ea58887
- signature
- unsigned
3 files · +121 -0
A .github/ISSUE_TEMPLATE/bug_report.yml +65 -0
| @@ -0,0 +1,65 @@ | |||
| 1 | + | name: Bug report | |
| 2 | + | description: Report something that's broken | |
| 3 | + | title: "[Bug]: " | |
| 4 | + | labels: ["bug"] | |
| 5 | + | body: | |
| 6 | + | - type: textarea | |
| 7 | + | id: description | |
| 8 | + | attributes: | |
| 9 | + | label: What happened? | |
| 10 | + | description: Be specific. Include error messages if any. | |
| 11 | + | validations: | |
| 12 | + | required: true | |
| 13 | + | ||
| 14 | + | - type: textarea | |
| 15 | + | id: repro | |
| 16 | + | attributes: | |
| 17 | + | label: Steps to reproduce | |
| 18 | + | description: Minimal steps to trigger the bug. | |
| 19 | + | validations: | |
| 20 | + | required: true | |
| 21 | + | ||
| 22 | + | - type: textarea | |
| 23 | + | id: expected | |
| 24 | + | attributes: | |
| 25 | + | label: Expected behavior | |
| 26 | + | description: What should have happened instead? | |
| 27 | + | placeholder: "I expected zot to..." | |
| 28 | + | validations: | |
| 29 | + | required: true | |
| 30 | + | ||
| 31 | + | - type: input | |
| 32 | + | id: version | |
| 33 | + | attributes: | |
| 34 | + | label: Version | |
| 35 | + | description: "e.g. 0.0.1 — run `zot --version` to check" | |
| 36 | + | validations: | |
| 37 | + | required: true | |
| 38 | + | ||
| 39 | + | - type: dropdown | |
| 40 | + | id: os | |
| 41 | + | attributes: | |
| 42 | + | label: Operating system | |
| 43 | + | options: | |
| 44 | + | - macOS | |
| 45 | + | - Linux | |
| 46 | + | - Windows | |
| 47 | + | - Other | |
| 48 | + | validations: | |
| 49 | + | required: true | |
| 50 | + | ||
| 51 | + | - type: textarea | |
| 52 | + | id: logs | |
| 53 | + | attributes: | |
| 54 | + | label: Logs / screenshots | |
| 55 | + | description: | | |
| 56 | + | If applicable, paste relevant terminal output or attach screenshots. | |
| 57 | + | render: shell | |
| 58 | + | ||
| 59 | + | - type: checkboxes | |
| 60 | + | id: checks | |
| 61 | + | attributes: | |
| 62 | + | label: Before submitting | |
| 63 | + | options: | |
| 64 | + | - label: I searched existing issues and didn't find a duplicate | |
| 65 | + | required: true | |
| @@ -0,0 +1,65 @@ | |||||
| 1 | + | name: Bug report | |||
| 2 | + | description: Report something that's broken | |||
| 3 | + | title: "[Bug]: " | |||
| 4 | + | labels: ["bug"] | |||
| 5 | + | body: | |||
| 6 | + | - type: textarea | |||
| 7 | + | id: description | |||
| 8 | + | attributes: | |||
| 9 | + | label: What happened? | |||
| 10 | + | description: Be specific. Include error messages if any. | |||
| 11 | + | validations: | |||
| 12 | + | required: true | |||
| 13 | + | ||||
| 14 | + | - type: textarea | |||
| 15 | + | id: repro | |||
| 16 | + | attributes: | |||
| 17 | + | label: Steps to reproduce | |||
| 18 | + | description: Minimal steps to trigger the bug. | |||
| 19 | + | validations: | |||
| 20 | + | required: true | |||
| 21 | + | ||||
| 22 | + | - type: textarea | |||
| 23 | + | id: expected | |||
| 24 | + | attributes: | |||
| 25 | + | label: Expected behavior | |||
| 26 | + | description: What should have happened instead? | |||
| 27 | + | placeholder: "I expected zot to..." | |||
| 28 | + | validations: | |||
| 29 | + | required: true | |||
| 30 | + | ||||
| 31 | + | - type: input | |||
| 32 | + | id: version | |||
| 33 | + | attributes: | |||
| 34 | + | label: Version | |||
| 35 | + | description: "e.g. 0.0.1 — run `zot --version` to check" | |||
| 36 | + | validations: | |||
| 37 | + | required: true | |||
| 38 | + | ||||
| 39 | + | - type: dropdown | |||
| 40 | + | id: os | |||
| 41 | + | attributes: | |||
| 42 | + | label: Operating system | |||
| 43 | + | options: | |||
| 44 | + | - macOS | |||
| 45 | + | - Linux | |||
| 46 | + | - Windows | |||
| 47 | + | - Other | |||
| 48 | + | validations: | |||
| 49 | + | required: true | |||
| 50 | + | ||||
| 51 | + | - type: textarea | |||
| 52 | + | id: logs | |||
| 53 | + | attributes: | |||
| 54 | + | label: Logs / screenshots | |||
| 55 | + | description: | | |||
| 56 | + | If applicable, paste relevant terminal output or attach screenshots. | |||
| 57 | + | render: shell | |||
| 58 | + | ||||
| 59 | + | - type: checkboxes | |||
| 60 | + | id: checks | |||
| 61 | + | attributes: | |||
| 62 | + | label: Before submitting | |||
| 63 | + | options: | |||
| 64 | + | - label: I searched existing issues and didn't find a duplicate | |||
| 65 | + | required: true | |||
A .github/ISSUE_TEMPLATE/config.yml +1 -0
| @@ -0,0 +1,1 @@ | |||
| 1 | + | blank_issues_enabled: false | |
| @@ -0,0 +1,1 @@ | |||||
| 1 | + | blank_issues_enabled: false | |||
A .github/ISSUE_TEMPLATE/feature_request.yml +55 -0
| @@ -0,0 +1,55 @@ | |||
| 1 | + | name: Feature request | |
| 2 | + | description: Suggest a new feature or improvement | |
| 3 | + | title: "[Feature]: " | |
| 4 | + | labels: ["enhancement"] | |
| 5 | + | body: | |
| 6 | + | - type: markdown | |
| 7 | + | attributes: | |
| 8 | + | value: | | |
| 9 | + | Thanks for the idea! A short conversation here saves everyone time before any code is written. | |
| 10 | + | ||
| 11 | + | Zot is intentionally focused — not every idea will make it in. A "no" is not a judgment of the idea. | |
| 12 | + | ||
| 13 | + | - type: textarea | |
| 14 | + | id: problem | |
| 15 | + | attributes: | |
| 16 | + | label: What problem does this solve? | |
| 17 | + | description: | | |
| 18 | + | The **why**, not the **what**. What were you trying to do when you wished this existed? | |
| 19 | + | placeholder: "When I'm working with multiple providers, I want to switch between them without restarting zot." | |
| 20 | + | validations: | |
| 21 | + | required: true | |
| 22 | + | ||
| 23 | + | - type: textarea | |
| 24 | + | id: proposal | |
| 25 | + | attributes: | |
| 26 | + | label: Proposed solution | |
| 27 | + | description: How would you imagine using this? UX sketch, CLI flags, behavior, anything that helps us picture it. | |
| 28 | + | validations: | |
| 29 | + | required: true | |
| 30 | + | ||
| 31 | + | - type: textarea | |
| 32 | + | id: alternatives | |
| 33 | + | attributes: | |
| 34 | + | label: Alternatives considered | |
| 35 | + | description: What workarounds have you tried? What other tools handle this well? | |
| 36 | + | placeholder: "I tried X, but it doesn't solve Y because..." | |
| 37 | + | ||
| 38 | + | - type: dropdown | |
| 39 | + | id: contribution | |
| 40 | + | attributes: | |
| 41 | + | label: Are you willing to contribute the implementation? | |
| 42 | + | options: | |
| 43 | + | - "Yes, with guidance" | |
| 44 | + | - "Yes, I can do it" | |
| 45 | + | - "No, just suggesting" | |
| 46 | + | validations: | |
| 47 | + | required: true | |
| 48 | + | ||
| 49 | + | - type: checkboxes | |
| 50 | + | id: checks | |
| 51 | + | attributes: | |
| 52 | + | label: Before submitting | |
| 53 | + | options: | |
| 54 | + | - label: I searched existing issues and didn't find a duplicate | |
| 55 | + | required: true | |
| @@ -0,0 +1,55 @@ | |||||
| 1 | + | name: Feature request | |||
| 2 | + | description: Suggest a new feature or improvement | |||
| 3 | + | title: "[Feature]: " | |||
| 4 | + | labels: ["enhancement"] | |||
| 5 | + | body: | |||
| 6 | + | - type: markdown | |||
| 7 | + | attributes: | |||
| 8 | + | value: | | |||
| 9 | + | Thanks for the idea! A short conversation here saves everyone time before any code is written. | |||
| 10 | + | ||||
| 11 | + | Zot is intentionally focused — not every idea will make it in. A "no" is not a judgment of the idea. | |||
| 12 | + | ||||
| 13 | + | - type: textarea | |||
| 14 | + | id: problem | |||
| 15 | + | attributes: | |||
| 16 | + | label: What problem does this solve? | |||
| 17 | + | description: | | |||
| 18 | + | The **why**, not the **what**. What were you trying to do when you wished this existed? | |||
| 19 | + | placeholder: "When I'm working with multiple providers, I want to switch between them without restarting zot." | |||
| 20 | + | validations: | |||
| 21 | + | required: true | |||
| 22 | + | ||||
| 23 | + | - type: textarea | |||
| 24 | + | id: proposal | |||
| 25 | + | attributes: | |||
| 26 | + | label: Proposed solution | |||
| 27 | + | description: How would you imagine using this? UX sketch, CLI flags, behavior, anything that helps us picture it. | |||
| 28 | + | validations: | |||
| 29 | + | required: true | |||
| 30 | + | ||||
| 31 | + | - type: textarea | |||
| 32 | + | id: alternatives | |||
| 33 | + | attributes: | |||
| 34 | + | label: Alternatives considered | |||
| 35 | + | description: What workarounds have you tried? What other tools handle this well? | |||
| 36 | + | placeholder: "I tried X, but it doesn't solve Y because..." | |||
| 37 | + | ||||
| 38 | + | - type: dropdown | |||
| 39 | + | id: contribution | |||
| 40 | + | attributes: | |||
| 41 | + | label: Are you willing to contribute the implementation? | |||
| 42 | + | options: | |||
| 43 | + | - "Yes, with guidance" | |||
| 44 | + | - "Yes, I can do it" | |||
| 45 | + | - "No, just suggesting" | |||
| 46 | + | validations: | |||
| 47 | + | required: true | |||
| 48 | + | ||||
| 49 | + | - type: checkboxes | |||
| 50 | + | id: checks | |||
| 51 | + | attributes: | |||
| 52 | + | label: Before submitting | |||
| 53 | + | options: | |||
| 54 | + | - label: I searched existing issues and didn't find a duplicate | |||
| 55 | + | required: true | |||