Skip to content

Commit 220231e

Browse files
committed
chore: format issue-review.md
1 parent b3b2b3e commit 220231e

1 file changed

Lines changed: 41 additions & 22 deletions

File tree

.github/skills/issue-review.md

Lines changed: 41 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,11 @@ Recommend **CLOSE** (state_reason: `completed`) if, based on references within t
6969
When closing, cite the specific PR number and release version if known.
7070

7171
**Template:**
72+
7273
> This issue has been fixed in PR #XXXX, which was released in **wrangler X.Y.Z** (or the relevant package version). Please update and let us know if you're still seeing the issue.
7374
7475
Or for older issues where the fix can't be pinpointed:
76+
7577
> This is a fairly old issue, and from testing with the latest version, it appears to have been resolved. I'm going to close it for now — if you're still running into problems on the latest version, feel free to open a new issue with more details and we can investigate further.
7678
7779
#### 2d: Duplicate
@@ -81,9 +83,11 @@ Recommend **CLOSE** (state_reason: `not_planned`) if a comment or linked referen
8183
When closing, link to the canonical issue.
8284

8385
**Template:**
86+
8487
> Closing as a duplicate of #XXXX. Please follow that issue for updates.
8588
8689
If the duplicate is in another repo:
90+
8791
> I'm closing this as a duplicate of <owner/repo>#XXXX, which is where this is being tracked.
8892
8993
#### 2e: Not workers-sdk / Wrong Repo
@@ -98,14 +102,17 @@ Recommend **CLOSE** (state_reason: `not_planned`) if:
98102
**Templates:**
99103

100104
For framework issues:
105+
101106
> It looks like this issue is coming from <framework>, rather than from workers-sdk. I'd recommend opening an issue on that project's repo: <link>. If it turns out to be a workers-sdk issue after all, feel free to open a new issue here with more details.
102107
103108
For runtime issues:
109+
104110
> This looks like a Workers runtime issue rather than a tooling issue. The right place to track this is [cloudflare/workerd](https://github.com/cloudflare/workerd) so I've moved the issue there.
105111
106112
(Set Action field to: "Transfer to cloudflare/workerd, then post this comment.")
107113

108114
For account/support issues:
115+
109116
> Unfortunately, we're unable to provide support for account-level issues via GitHub. Please contact Cloudflare Support at https://dash.cloudflare.com/?to=/:account/support or the email address mentioned in the error message.
110117
111118
#### 2f: Stale / No Response
@@ -117,9 +124,11 @@ Recommend **CLOSE** (state_reason: `not_planned`) if:
117124
- A maintainer asked for a reproduction or clarification and the reporter never responded
118125

119126
**Template:**
127+
120128
> We haven't heard from you in a while so I'm going to close this issue for now. If you're still running into problems, feel free to open a new issue with more details and we can investigate further.
121129
122130
For very old issues:
131+
123132
> This is a very old issue so I'm going to close it for now. If you're still running into problems on the latest version, feel free to comment with more details and we can investigate further.
124133
125134
#### 2g: Transient Platform Issue
@@ -131,9 +140,11 @@ Recommend **CLOSE** (state_reason: `completed`) if:
131140
- The error is from Cloudflare's API (not from Wrangler itself) and there's no way to fix it in workers-sdk
132141

133142
**Template:**
143+
134144
> This was a transient API issue, and should be resolved now. If you're still seeing this error, please open a new issue with the latest details and we can investigate further.
135145
136146
Or for old transient issues:
147+
137148
> This appears to have been a transient server-side API issue. Similar reports were caused by Cloudflare API incidents that have since been resolved. I'm going to close this for now.
138149
139150
#### 2h: User Error / Misunderstanding
@@ -147,6 +158,7 @@ Recommend **CLOSE** (state_reason: `not_planned`) if:
147158
When closing, explain the correct approach and link to relevant documentation. Be helpful, not dismissive.
148159

149160
**Template:**
161+
150162
> This isn't a bug — <brief explanation of the correct behavior>. You can find more details in the docs: <link>. I'm going to close this for now, but feel free to ask on our [Discord](https://discord.cloudflare.com) if you have more questions.
151163
152164
#### 2i: Breaking Change
@@ -160,6 +172,7 @@ The issue should remain open as a tracking item. Do not close it — the team ha
160172
**Suggested labels:** `breaking change`
161173

162174
**Template:**
175+
163176
> Changing this behavior at this stage would be a breaking change, so it will need to wait for the next major version. I've added the `breaking change` label to track this.
164177
165178
(Set Action field to: "Apply `breaking change` label, then post this comment.")
@@ -175,9 +188,11 @@ Recommend **CLOSE** (state_reason: `not_planned`) if:
175188
**Templates:**
176189

177190
For design decisions:
191+
178192
> This is intentional behavior — <brief explanation>. I don't think we're likely to change this in the near future, but we appreciate the feedback.
179193
180194
For feature requests that won't happen:
195+
181196
> Thanks for the suggestion. We don't intend to implement this right now, but it may be revisited in future. <Optional: brief explanation of why, or pointer to an alternative approach.>
182197
183198
#### 2k: Feature Superseded / Deprecated
@@ -189,6 +204,7 @@ Recommend **CLOSE** (state_reason: `completed`) if:
189204
- A newer feature or package addresses the underlying need
190205

191206
**Template:**
207+
192208
> This has been addressed by <feature/package>. <Brief explanation of how it solves the original request.> I'm going to close this for now.
193209
194210
### Step 3: Check for Insufficient Information
@@ -201,7 +217,9 @@ If the issue wasn't caught by Step 2, recommend **NEEDS MORE INFO** if:
201217
- The error message is missing or truncated
202218

203219
**Template:**
220+
204221
> Thanks for reporting this. Could you provide <specific missing information>? In particular:
222+
>
205223
> - <specific question 1>
206224
> - <specific question 2>
207225
>
@@ -215,27 +233,27 @@ If the issue wasn't caught by Step 2, recommend **NEEDS MORE INFO** if:
215233

216234
Map the issue to a package based on labels, title, and body content:
217235

218-
| Signal | Package |
219-
|---|---|
220-
| `wrangler` label, wrangler CLI commands, `wrangler.toml`/`wrangler.json` | `packages/wrangler` |
221-
| `miniflare` label, local dev simulation | `packages/miniflare` |
222-
| `d1` label, D1 database, `d1 execute`, migrations | `packages/wrangler` (D1 code is in wrangler) |
223-
| `vitest` label, worker tests, `vitest-pool-workers` | `packages/vitest-pool-workers` |
224-
| `vite-plugin` label, vite dev, `@cloudflare/vite-plugin` | `packages/vite-plugin-cloudflare` |
225-
| `c3` label, `create-cloudflare`, project scaffolding | `packages/create-cloudflare` |
226-
| `pages` label, Pages deployment, `_routes.json`, `_headers` | `packages/wrangler` (Pages code is in wrangler) |
227-
| `Workers + Assets` label, static asset serving | `packages/wrangler` |
228-
| `containers` label, container registry | `packages/wrangler` |
229-
| `workflows` label, Workflows API | `packages/wrangler` |
230-
| `workers-builds` label | Workers Builds (may be internal) |
231-
| `python` label, Python Workers | `packages/wrangler` |
232-
| `workers for platforms` label, dispatch namespaces | `packages/wrangler` |
233-
| `kv-asset-handler` label | `packages/kv-asset-handler` |
234-
| `types` label, `wrangler types` command | `packages/wrangler` |
235-
| R2, KV, Queues, Durable Objects, Vectorize bindings | `packages/wrangler` |
236-
| `node compat`/`nodejs compat` label, Node.js APIs | May be workerd or wrangler depending on context |
237-
| Workers runtime behavior (not tooling) | Likely belongs in cloudflare/workerd |
238-
| Cloudflare dashboard, API behavior | Likely a platform issue, not workers-sdk |
236+
| Signal | Package |
237+
| ------------------------------------------------------------------------ | ----------------------------------------------- |
238+
| `wrangler` label, wrangler CLI commands, `wrangler.toml`/`wrangler.json` | `packages/wrangler` |
239+
| `miniflare` label, local dev simulation | `packages/miniflare` |
240+
| `d1` label, D1 database, `d1 execute`, migrations | `packages/wrangler` (D1 code is in wrangler) |
241+
| `vitest` label, worker tests, `vitest-pool-workers` | `packages/vitest-pool-workers` |
242+
| `vite-plugin` label, vite dev, `@cloudflare/vite-plugin` | `packages/vite-plugin-cloudflare` |
243+
| `c3` label, `create-cloudflare`, project scaffolding | `packages/create-cloudflare` |
244+
| `pages` label, Pages deployment, `_routes.json`, `_headers` | `packages/wrangler` (Pages code is in wrangler) |
245+
| `Workers + Assets` label, static asset serving | `packages/wrangler` |
246+
| `containers` label, container registry | `packages/wrangler` |
247+
| `workflows` label, Workflows API | `packages/wrangler` |
248+
| `workers-builds` label | Workers Builds (may be internal) |
249+
| `python` label, Python Workers | `packages/wrangler` |
250+
| `workers for platforms` label, dispatch namespaces | `packages/wrangler` |
251+
| `kv-asset-handler` label | `packages/kv-asset-handler` |
252+
| `types` label, `wrangler types` command | `packages/wrangler` |
253+
| R2, KV, Queues, Durable Objects, Vectorize bindings | `packages/wrangler` |
254+
| `node compat`/`nodejs compat` label, Node.js APIs | May be workerd or wrangler depending on context |
255+
| Workers runtime behavior (not tooling) | Likely belongs in cloudflare/workerd |
256+
| Cloudflare dashboard, API behavior | Likely a platform issue, not workers-sdk |
239257

240258
### Step 5: Assess Reproducibility and Severity
241259

@@ -311,12 +329,13 @@ duplicate candidates. Only include what's relevant.>
311329

312330
> <The exact comment to post on the issue. Follow the templates above for the
313331
> matching closure category. Key principles:
332+
>
314333
> - Always offer an escape hatch ("feel free to open a new issue")
315334
> - Link to specific PRs, releases, or docs when available
316335
> - Be concise for straightforward closures, detailed for design decisions
317336
> - Never be dismissive or snarky, even for spam (just close silently) or user error
318337
> - For NEEDS MORE INFO, ask specific questions (not generic "please provide more details")
319-
> Omit this section entirely for spam (close without comment) or if no comment is needed.>
338+
> Omit this section entirely for spam (close without comment) or if no comment is needed.>
320339
```
321340

322341
### Output Step 2: Write Summary File

0 commit comments

Comments
 (0)