From 5c01ace9118caa0e36712d06bc4623926ceba925 Mon Sep 17 00:00:00 2001 From: Rhys Sullivan <39114868+RhysSullivan@users.noreply.github.com> Date: Fri, 28 Aug 2026 01:10:21 -0700 Subject: [PATCH] Add bug report, feature request, and pull request templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 100 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 51 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 30 +++++++ 3 files changed, 181 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..a2fb5605ad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,100 @@ +name: Bug report +description: Something in Executor does not work as expected. +title: "[bug] " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Please update to the latest version first — the bug may already be fixed. + If the desktop app crashes, will not start, or shows a blank window, use the + **[Desktop app crash](?template=desktop-crash.yml)** template instead. + - type: input + id: version + attributes: + label: Executor version + description: Run `executor --version`, or open the About menu in the desktop app. + placeholder: "1.5.4" + validations: + required: true + - type: dropdown + id: surface + attributes: + label: How do you run Executor? + options: + - Executor Cloud + - CLI + - Desktop app + - Self-host (Docker) + - Self-host (Cloudflare) + validations: + required: true + - type: dropdown + id: os + attributes: + label: Operating system + description: For Executor Cloud, select the system you browse from. + options: + - macOS (Apple Silicon) + - macOS (Intel) + - Windows + - Linux + validations: + required: true + - type: input + id: integration + attributes: + label: Integration involved + description: The integration or source type, if the bug is specific to one. + placeholder: "MCP server, OpenAPI spec, GraphQL API, …" + - type: textarea + id: what-happened + attributes: + label: What happened + description: Describe the behaviour you saw. + validations: + required: true + - type: textarea + id: expected + attributes: + label: What you expected + description: Describe the behaviour you wanted instead. + validations: + required: true + - type: textarea + id: repro + attributes: + label: Steps to reproduce + description: The smallest sequence that shows the bug. Include the commands you ran. + value: | + 1. + 2. + 3. + validations: + required: true + - type: textarea + id: logs + attributes: + label: Diagnostics / logs + description: | + In the desktop app, open the **Executor** menu → **Export Diagnostics…** and attach + the zip — it has everything we need and no secrets. + + Otherwise attach the relevant log: + - CLI / self-host: `~/.executor/logs/` (run `executor service status` for the exact path) + - macOS desktop: `~/Library/Logs/Executor/main.log` + - Windows desktop: `%APPDATA%\Executor\logs\main.log` + - Linux desktop: `~/.config/Executor/logs/main.log` + + (Please don't attach anything else from `~/.executor` — that's where your data and + secrets live. Remove API keys and tokens from anything you paste.) + placeholder: Drag the diagnostics zip or log file here. + - type: checkboxes + id: checks + attributes: + label: Before you submit + options: + - label: I searched the open issues for a duplicate. + required: true + - label: I removed all keys, tokens, and credentials from this report. + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000..82345ebfeb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,51 @@ +name: Feature request +description: Suggest a capability or an improvement for Executor. +title: "[feature] " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Tell us the task you want to do and why Executor cannot do it today. + A concrete example helps more than a general proposal. + - type: textarea + id: problem + attributes: + label: The problem + description: What are you trying to do, and where does Executor stop you? + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposed shape + description: | + The change you want, as concretely as you can describe it. Name the command, + the setting, or the screen where it would live. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: Workarounds you tried, and why they are not sufficient. + - type: dropdown + id: surface + attributes: + label: Where it belongs + description: Select every form of Executor this applies to. + options: + - Executor Cloud + - CLI + - Desktop app + - Self-host (Docker) + - Self-host (Cloudflare) + - Not sure + multiple: true + - type: checkboxes + id: checks + attributes: + label: Before you submit + options: + - label: I searched the open issues for a duplicate. + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..1fc620b824 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,30 @@ + + +## Summary + + + +## Linked issue + +Fixes # + +## Verification + + + +- [ ] `bun run format:check` +- [ ] `bun run lint` +- [ ] `bun run typecheck` +- [ ] `bun run test` +- [ ] e2e — name the scenario, and link the recording or trace: + +## Checklist + +- [ ] Added a changeset (`bun run changeset`), or this change needs none. +- [ ] Added or updated tests for the new behaviour. +- [ ] No secrets, credentials, or private data in the diff.