diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..2335c817e3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,136 @@ +name: Bug Report +description: Report a bug, crash, or unexpected behavior +title: "[Bug] " +labels: + - type:bug +body: + - type: markdown + attributes: + value: | + Thanks for reporting a bug. Please fill in as much detail as you can — it helps us fix things faster. + + - type: dropdown + id: component + attributes: + label: Component + description: Which part of SynthOrg is affected? + options: + - Backend (Python API / engine) + - Dashboard (Vue web UI) + - CLI (Go binary / installer) + - Docker (compose / containers) + - Docs + validations: + required: true + + - type: dropdown + id: install-method + attributes: + label: CLI installation method (if relevant) + description: How did you install the SynthOrg CLI? Skip if the bug is not CLI-related. + options: + - "curl | sh (Linux/macOS)" + - PowerShell installer (Windows) + - Manual download from GitHub Releases + - Built from source (go build) + - N/A + validations: + required: false + + - type: dropdown + id: severity + attributes: + label: Severity + options: + - Crash / data loss + - Wrong behavior (feature broken) + - Performance issue + - Cosmetic / minor + validations: + required: true + + - type: dropdown + id: os + attributes: + label: Operating system + options: + - macOS (Apple Silicon / arm64) + - macOS (Intel / amd64) + - Linux (amd64) + - Linux (arm64) + - Windows (amd64) + - Windows (arm64) + validations: + required: true + + - type: textarea + id: description + attributes: + label: What happened? + description: Describe what you expected and what actually happened. + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to reproduce + placeholder: | + 1. Run `synthorg start` + 2. Open http://localhost:3000 + 3. Click on ... + 4. See error + validations: + required: true + + - type: textarea + id: error + attributes: + label: Error output / logs + description: Full error message, stack trace, or relevant log output. + render: shell + validations: + required: false + + - type: textarea + id: version + attributes: + label: Version info + description: "Output of `synthorg version`, or the version you tried to install. Write 'not installed' if installation failed." + placeholder: | + synthorg v0.3.0 + commit: abc1234 + built: 2026-03-15T12:00:00Z + render: shell + validations: + required: true + + - type: textarea + id: doctor + attributes: + label: Doctor output + description: | + Paste the output of `synthorg doctor`. It collects OS, architecture, + Docker version, container status, health checks, and config (secrets + are redacted). If SynthOrg is not installed, write "not installed". + placeholder: | + { + "os": "windows", + "arch": "amd64", + "cli_version": "v0.3.0", + "docker_version": "27.x", + "compose_version": "2.x", + "health_status": "healthy", + "compose_file_exists": true + } + render: json + validations: + required: false + + - type: textarea + id: context + attributes: + label: Additional context + description: "Screenshots, workarounds tried, related issues, etc." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..7152fe5a5f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Documentation + url: https://synthorg.io/docs/ + about: Check the docs before opening an issue + - name: Discussions + url: https://github.com/Aureliolo/synthorg/discussions + about: Ask questions or share ideas + - name: Security Vulnerabilities + url: https://github.com/Aureliolo/synthorg/security/policy + about: Report security vulnerabilities privately diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000..0dd6041b98 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,75 @@ +name: Feature Request +description: Suggest a new feature or enhancement +title: "[Feature] " +labels: + - type:feature +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a feature. Describe what you'd like and why it matters. + + - type: dropdown + id: component + attributes: + label: Component + description: Which part of SynthOrg does this affect? + options: + - Backend (Python API / engine) + - Dashboard (Vue web UI) + - CLI (Go binary) + - Docker (compose / containers) + - Docs + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: What do you want and what problem does it solve? + validations: + required: true + + - type: textarea + id: motivation + attributes: + label: Motivation + description: Why is this needed? What's the current workaround (if any)? + validations: + required: false + + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: Other approaches you thought of and why this one is better. + validations: + required: false + + - type: input + id: design-spec + attributes: + label: Design spec reference + description: "Which `docs/design/` page is relevant? See [DESIGN_SPEC.md](../blob/main/docs/DESIGN_SPEC.md) for the index." + placeholder: "e.g. docs/design/engine.md §6.5" + validations: + required: false + + - type: textarea + id: dependencies + attributes: + label: Dependencies / related issues + description: "Issues that should be done first or are closely related." + placeholder: | + - #NNN (description) + validations: + required: false + + - type: textarea + id: context + attributes: + label: Additional context + description: "Mockups, links, research, related issues, etc." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/installer-failure.yml b/.github/ISSUE_TEMPLATE/installer-failure.yml deleted file mode 100644 index 3037c56655..0000000000 --- a/.github/ISSUE_TEMPLATE/installer-failure.yml +++ /dev/null @@ -1,79 +0,0 @@ -name: CLI Installation Failure -description: Report a problem installing the SynthOrg CLI -title: "[CLI Install] " -labels: - - type:bug - - scope:cli -body: - - type: markdown - attributes: - value: | - Thanks for reporting an installation issue. Please fill in the details below. - - - type: dropdown - id: install-method - attributes: - label: Installation method - options: - - Homebrew (brew install) - - Scoop (scoop install) - - curl | sh (Linux/macOS) - - PowerShell installer (Windows) - - Manual download from GitHub Releases - - Built from source (go build) - validations: - required: true - - - type: dropdown - id: os - attributes: - label: Operating system - options: - - macOS (Apple Silicon / arm64) - - macOS (Intel / amd64) - - Linux (amd64) - - Linux (arm64) - - Windows (amd64) - - Windows (arm64) - validations: - required: true - - - type: textarea - id: version - attributes: - label: Version info - description: "Output of `synthorg version` (if installed) or the version you tried to install" - placeholder: | - synthorg dev - commit: none - built: unknown - validations: - required: false - - - type: textarea - id: error - attributes: - label: Error output - description: "Full error message or terminal output" - render: shell - validations: - required: true - - - type: textarea - id: steps - attributes: - label: Steps to reproduce - description: "Exact commands you ran" - placeholder: | - 1. curl -sSfL https://... | sh - 2. ... - validations: - required: true - - - type: textarea - id: context - attributes: - label: Additional context - description: "Anything else that might help (Docker version, shell, proxy, etc.)" - validations: - required: false