History

Add bug report, feature request, and pull request templates (#1812)

Rhys Sullivan committed 2 months ago

Commit 38407531 parent 97ff3883 files · +181 −0Browse files

Showing the changes to .github (3 of 3 files). Show all

Unified · Split

3 files
  1. .github/ISSUE_TEMPLATE/bug_report.yml +100 −0
  2. .github/ISSUE_TEMPLATE/feature_request.yml +51 −0
  3. .github/PULL_REQUEST_TEMPLATE.md +30 −0
.github/ISSUE_TEMPLATE/bug_report.yml+100−0
@@ -0,0 +1,100 @@
1+name: Bug report
2+description: Something in Executor does not work as expected.
3+title: "[bug] "
4+labels: ["bug"]
5+body:
6+ - type: markdown
7+ attributes:
8+ value: |
9+ Please update to the latest version first — the bug may already be fixed.
10+ If the desktop app crashes, will not start, or shows a blank window, use the
11+ **[Desktop app crash](?template=desktop-crash.yml)** template instead.
12+ - type: input
13+ id: version
14+ attributes:
15+ label: Executor version
16+ description: Run `executor --version`, or open the About menu in the desktop app.
17+ placeholder: "1.5.4"
18+ validations:
19+ required: true
20+ - type: dropdown
21+ id: surface
22+ attributes:
23+ label: How do you run Executor?
24+ options:
25+ - Executor Cloud
26+ - CLI
27+ - Desktop app
28+ - Self-host (Docker)
29+ - Self-host (Cloudflare)
30+ validations:
31+ required: true
32+ - type: dropdown
33+ id: os
34+ attributes:
35+ label: Operating system
36+ description: For Executor Cloud, select the system you browse from.
37+ options:
38+ - macOS (Apple Silicon)
39+ - macOS (Intel)
40+ - Windows
41+ - Linux
42+ validations:
43+ required: true
44+ - type: input
45+ id: integration
46+ attributes:
47+ label: Integration involved
48+ description: The integration or source type, if the bug is specific to one.
49+ placeholder: "MCP server, OpenAPI spec, GraphQL API, …"
50+ - type: textarea
51+ id: what-happened
52+ attributes:
53+ label: What happened
54+ description: Describe the behaviour you saw.
55+ validations:
56+ required: true
57+ - type: textarea
58+ id: expected
59+ attributes:
60+ label: What you expected
61+ description: Describe the behaviour you wanted instead.
62+ validations:
63+ required: true
64+ - type: textarea
65+ id: repro
66+ attributes:
67+ label: Steps to reproduce
68+ description: The smallest sequence that shows the bug. Include the commands you ran.
69+ value: |
70+ 1.
71+ 2.
72+ 3.
73+ validations:
74+ required: true
75+ - type: textarea
76+ id: logs
77+ attributes:
78+ label: Diagnostics / logs
79+ description: |
80+ In the desktop app, open the **Executor** menu → **Export Diagnostics…** and attach
81+ the zip — it has everything we need and no secrets.
82+
83+ Otherwise attach the relevant log:
84+ - CLI / self-host: `~/.executor/logs/` (run `executor service status` for the exact path)
85+ - macOS desktop: `~/Library/Logs/Executor/main.log`
86+ - Windows desktop: `%APPDATA%\Executor\logs\main.log`
87+ - Linux desktop: `~/.config/Executor/logs/main.log`
88+
89+ (Please don't attach anything else from `~/.executor` — that's where your data and
90+ secrets live. Remove API keys and tokens from anything you paste.)
91+ placeholder: Drag the diagnostics zip or log file here.
92+ - type: checkboxes
93+ id: checks
94+ attributes:
95+ label: Before you submit
96+ options:
97+ - label: I searched the open issues for a duplicate.
98+ required: true
99+ - label: I removed all keys, tokens, and credentials from this report.
100+ required: true
.github/ISSUE_TEMPLATE/feature_request.yml+51−0
@@ -0,0 +1,51 @@
1+name: Feature request
2+description: Suggest a capability or an improvement for Executor.
3+title: "[feature] "
4+labels: ["enhancement"]
5+body:
6+ - type: markdown
7+ attributes:
8+ value: |
9+ Tell us the task you want to do and why Executor cannot do it today.
10+ A concrete example helps more than a general proposal.
11+ - type: textarea
12+ id: problem
13+ attributes:
14+ label: The problem
15+ description: What are you trying to do, and where does Executor stop you?
16+ validations:
17+ required: true
18+ - type: textarea
19+ id: proposal
20+ attributes:
21+ label: Proposed shape
22+ description: |
23+ The change you want, as concretely as you can describe it. Name the command,
24+ the setting, or the screen where it would live.
25+ validations:
26+ required: true
27+ - type: textarea
28+ id: alternatives
29+ attributes:
30+ label: Alternatives
31+ description: Workarounds you tried, and why they are not sufficient.
32+ - type: dropdown
33+ id: surface
34+ attributes:
35+ label: Where it belongs
36+ description: Select every form of Executor this applies to.
37+ options:
38+ - Executor Cloud
39+ - CLI
40+ - Desktop app
41+ - Self-host (Docker)
42+ - Self-host (Cloudflare)
43+ - Not sure
44+ multiple: true
45+ - type: checkboxes
46+ id: checks
47+ attributes:
48+ label: Before you submit
49+ options:
50+ - label: I searched the open issues for a duplicate.
51+ required: true
.github/PULL_REQUEST_TEMPLATE.md+30−0
@@ -0,0 +1,30 @@
1+<!-- Keep this short and plain. Delete the sections that do not apply. -->
2+
3+## Summary
4+
5+<!-- What does this change do, and why? One or two sentences. -->
6+
7+## Linked issue
8+
9+Fixes #
10+
11+## Verification
12+
13+<!--
14+Say what you ran and what it showed. File paths alone are not evidence.
15+User-visible work needs a specific e2e run or a browsable dev instance, plus
16+the recording or trace that shows what to inspect. Add an e2e scenario when
17+none covers the changed behaviour.
18+-->
19+
20+- [ ] `bun run format:check`
21+- [ ] `bun run lint`
22+- [ ] `bun run typecheck`
23+- [ ] `bun run test`
24+- [ ] e2e — name the scenario, and link the recording or trace:
25+
26+## Checklist
27+
28+- [ ] Added a changeset (`bun run changeset`), or this change needs none.
29+- [ ] Added or updated tests for the new behaviour.
30+- [ ] No secrets, credentials, or private data in the diff.