|
16 | 16 |
|
17 | 17 | ## Step 1 — Check for Existing Hero Scenarios |
18 | 18 |
|
19 | | -Check whether the service already has a `hero-scenarios.md` file. |
| 19 | +Check whether the service already has a `hero-scenarios.md` file (the |
| 20 | +check should be case-insensitive — e.g., `HERO_SCENARIOS.md` counts). |
20 | 21 | Look in the top-level service directory (e.g., |
21 | 22 | `specification/loadtestservice/hero-scenarios.md`) and in each spec subdirectory |
22 | 23 | (e.g., `resource-manager/Microsoft.LoadTestService/loadtesting/hero-scenarios.md`, |
@@ -267,19 +268,37 @@ The file should include: |
267 | 268 | does, who it is for, and what problem it solves. |
268 | 269 | 2. **Hero scenarios** — the scenarios generated in Step 3. |
269 | 270 |
|
270 | | -**If a `hero-scenarios.md` already exists**, post an inline code suggestion on |
271 | | -the file using `create-pull-request-review-comment`. Place the |
272 | | -comment at the end of the file and use a GitHub suggestion block so the |
273 | | -author can apply it with one click: |
| 271 | +**If a `hero-scenarios.md` already exists**, check whether the file is |
| 272 | +part of the PR diff (i.e., listed in the changed files of the pull request). |
274 | 273 |
|
275 | | -```` |
276 | | -```suggestion |
277 | | -<the new scenario section as raw markdown> |
278 | | -``` |
279 | | -```` |
| 274 | +- **If the file IS in the PR diff**, post an inline code suggestion on |
| 275 | + the file using `create-pull-request-review-comment`. Place the |
| 276 | + comment at the end of the file and use a GitHub suggestion block so the |
| 277 | + author can apply it with one click: |
| 278 | + |
| 279 | + ```` |
| 280 | + ```suggestion |
| 281 | + <the new scenario section as raw markdown> |
| 282 | + ``` |
| 283 | + ```` |
| 284 | + |
| 285 | + Then submit the review using `submit-pull-request-review` with event |
| 286 | + `COMMENT` and a one-sentence body summarizing what was suggested. |
| 287 | + |
| 288 | +- **If the file is NOT in the PR diff**, use `add-comment` to post a |
| 289 | + PR comment instead (review comments can only be placed on files in the |
| 290 | + diff). Format it as: |
| 291 | + |
| 292 | + ``` |
| 293 | + ## 📖 Suggested additions to hero-scenarios.md |
| 294 | +
|
| 295 | + > **Path:** `specification/{service}/{specDir}/hero-scenarios.md` |
| 296 | + > |
| 297 | + > The existing `hero-scenarios.md` does not cover the API surface in |
| 298 | + > this PR. Consider adding the following scenarios: |
280 | 299 |
|
281 | | -Then submit the review using `submit-pull-request-review` with event |
282 | | -`COMMENT` and a one-sentence body summarizing what was suggested. |
| 300 | + <the new scenario section as raw markdown — do NOT wrap it in a code fence> |
| 301 | + ``` |
283 | 302 |
|
284 | 303 | If the existing `hero-scenarios.md` already covers all the API surface in |
285 | 304 | this PR, submit a `COMMENT` review with a one-sentence body confirming no |
|
0 commit comments