chore: add PR template, issue templates (#1211)
* chore: add PR template, issue templates, and triage action Adds a complete contribution quality layer to reduce maintainer triage burden: - .github/pull_request_template.md — structured PR description with checklist enforcing target branch, one-concern rule, CI green, no print(), schema regeneration, and ADR/CONTEXT.md update requirements - .github/ISSUE_TEMPLATE/bug_report.yml — required-field YAML form; GitHub blocks submission until reproduction steps and environment are filled in - .github/ISSUE_TEMPLATE/feature_request.yml — required problem/proposal fields with duplicate-check prompt - .github/ISSUE_TEMPLATE/config.yml — disables blank issues; funnels questions to Discussions - .github/workflows/triage.yml — auto-closes issues and PRs from accounts younger than 7 days, and closes anything with an empty or unfilled body Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * chore: simplify to templates only — drop triage workflow - PR template: target main (not dev), strip TS/pnpm/ADR checklist items that aren't enforced in the current codebase yet - Remove .github/workflows/triage.yml — account-age and auto-close policy needs explicit maintainer sign-off before automation Issue templates and config.yml are unchanged. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * chore: drop CI-green item — no active CI workflow yet Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * chore: upgrade templates with feedback from #1222 and #1211 thread Bug report: - Add install method dropdown (Docker / pip / Windows / macOS) - Split into separate Expected Behaviour and Actual Behaviour fields - Add Model / Backend field for LLM-related bugs - Add prerequisites checkboxes: duplicate search, security vuln redirect, running latest main - Add Additional Information free-text field Feature request: - Add prerequisites checkboxes (searched issues, searched discussions, concrete proposal) - Add area dropdown (Chat/Email/Calendar/Cookbook/etc.) for triage - Rename and tighten Problem and Solution fields - Add Prior Art / Related Issues field - Add Alternatives Considered field config.yml: - Replace two generic links with three specific ones: Q&A discussions, Ideas discussions, and GitHub Security Advisories for vulnerabilities PR template: - Rename Summary section with clearer placeholder text - Add Linked Issue section (Fixes #NNN) - Add How to Test section with numbered placeholder steps - Add Screenshots section for UI changes - Add duplicate-search checklist item - Remove No print() item (style note, not a structural requirement) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
103
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
103
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,103 @@
|
||||
name: Bug Report
|
||||
description: Report a reproducible bug in Odysseus.
|
||||
labels: ["bug"]
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
**Before submitting:** search [open issues](https://github.com/pewdiepie-archdaemon/odysseus/issues)
|
||||
and [discussions](https://github.com/pewdiepie-archdaemon/odysseus/discussions) first.
|
||||
Duplicate reports slow things down.
|
||||
|
||||
For security vulnerabilities, **do not open a public issue** —
|
||||
use [GitHub Security Advisories](https://github.com/pewdiepie-archdaemon/odysseus/security/advisories/new)
|
||||
and read [SECURITY.md](https://github.com/pewdiepie-archdaemon/odysseus/blob/main/SECURITY.md) first.
|
||||
|
||||
- type: checkboxes
|
||||
id: prerequisites
|
||||
attributes:
|
||||
label: Prerequisites
|
||||
options:
|
||||
- label: I searched [open issues](https://github.com/pewdiepie-archdaemon/odysseus/issues?q=is%3Aissue+is%3Aopen) and [discussions](https://github.com/pewdiepie-archdaemon/odysseus/discussions) and did not find an existing report of this bug.
|
||||
required: true
|
||||
- label: This is **not** a security vulnerability. (Vulnerabilities go to [GitHub Security Advisories](https://github.com/pewdiepie-archdaemon/odysseus/security/advisories/new) — see [SECURITY.md](https://github.com/pewdiepie-archdaemon/odysseus/blob/main/SECURITY.md).)
|
||||
required: true
|
||||
- label: I am running the latest code from `main`.
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: install-method
|
||||
attributes:
|
||||
label: Install Method
|
||||
options:
|
||||
- Docker (docker compose up)
|
||||
- Manual Python install (pip / venv)
|
||||
- Windows native (launch-windows.ps1)
|
||||
- macOS app (build-macos-app.sh / start-macos.sh)
|
||||
- Other (describe in the reproduction steps below)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: os
|
||||
attributes:
|
||||
label: Operating System
|
||||
options:
|
||||
- Linux
|
||||
- macOS
|
||||
- Windows
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: Exact steps that reliably trigger the bug. The more specific, the faster this gets fixed.
|
||||
placeholder: |
|
||||
1. Go to ...
|
||||
2. Click / type ...
|
||||
3. Observe ...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected Behaviour
|
||||
description: What should have happened?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: actual
|
||||
attributes:
|
||||
label: Actual Behaviour
|
||||
description: What actually happened? Include the full error message if there is one.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Logs / Screenshots
|
||||
description: Paste relevant terminal output or attach screenshots. Remove API keys, passwords, and personal data before pasting.
|
||||
render: text
|
||||
|
||||
- type: input
|
||||
id: model-backend
|
||||
attributes:
|
||||
label: Model / Backend (if relevant)
|
||||
description: "e.g. Ollama + llama3.2:latest, vLLM + mistral-7b, OpenAI API, Anthropic API"
|
||||
placeholder: "Ollama + llama3.2:latest"
|
||||
|
||||
- type: textarea
|
||||
id: additional-info
|
||||
attributes:
|
||||
label: Additional Information
|
||||
description: Anything else that might help — browser console errors, related issues, things you already tried, or environment quirks.
|
||||
placeholder: |
|
||||
- Any other context goes here.
|
||||
- If you are willing to submit a PR that fixes this, mention it here.
|
||||
Reference in New Issue
Block a user