You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .agents/commands/comet/_pr-description-sync.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ Clean up `$TMP` on exit.
51
51
Apply the same logic as `/comet:create-pr` Step 6 (Extract Change Information) and Step 7 (Pre-fill PR Template). In particular:
52
52
53
53
- Fill every `##` section defined in `.github/pull_request_template.md`. Sections not applicable to this PR get `N/A`, never get removed.
54
-
- Re-derive the **Details**summary from the diff and commit messages.
54
+
- Re-derive the **Details**section from the diff and commit messages in the style set by `/comet:create-pr` Step 7 — what changes for a user, short, bulleted, authoritative, no summary of the diff. Keep the shape the section already uses (Before / After, flat list, or a couple of lines) unless the change no longer fits it.
55
55
- Re-derive the **Change checklist** from the file types changed (e.g., user-facing checked when UI files changed; documentation checked when `*.md` / `*.mdx` changed).
56
56
- Keep the existing **Issues** ticket reference if present (e.g., `OPIK-6296`); if missing, infer from branch name.
57
57
- Keep the existing **AI-WATERMARK** answers verbatim — never silently flip `yes`↔`no`.
Copy file name to clipboardExpand all lines: .agents/commands/comet/create-pr.md
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -181,7 +181,20 @@ This workflow will:
181
181
- **Fill every `##` section**in the template — the PR linter requires all sections to be present
182
182
- If a section is not applicable, write "N/A" rather than removing it
183
183
- **Section guidance**:
184
-
- **Details**: Implementation summary from git analysis (replace the HTML comment placeholder)
184
+
- **Details**: Replace the HTML comment placeholder with what changes for a user. A reviewer reads the diff for the code; this section tells them what is different when they use the product. Style:
185
+
186
+
- **Short.** Most PRs need 3–10 bullets. If it runs longer, the section is doing the diff's job — cut it.
187
+
- **Bullets, not prose paragraphs.** One behavior per bullet. Nest one level for sub-cases.
188
+
- **Authoritative.** State what happens: "The run is scored once." Not "This should now mean that the run will be scored once."
189
+
- **No fluff.** No motivation paragraph, no "this PR …", no approach summary, no benefits list, no restating the diff.
190
+
- **Observable behavior first.** What the UI shows, what the API returns, what gets scored, stored or logged. Name a class, method or file only when the behavior makes no sense without it.
191
+
192
+
Pick the shape that fits the change — do not force one:
193
+
194
+
- **Before / After bullet lists** when a behavior changed and the contrast is the point.
195
+
- **A flat bullet list** for a new capability, where there is no "before".
196
+
- **One or two lines** when users cannot see the change (refactor, dependency bump) — say what is unchanged and what improved, then stop.
197
+
185
198
- **Change checklist**: Auto-check based on file types changed (user-facing for UI changes, documentation for docs)
186
199
- **Issues**: Link to Jira ticket (e.g., `OPIK-2180`) or GitHub issue, or "NA" for hotfixes. List every ticket this PR **resolves** here with a normal hyphenated key.
187
200
- **Jira key convention across the whole body** (see git-workflow rule): the GitHub for Jira app links any `OPIK-<digits>` it finds in the PR body to that ticket's Development panel, and the link can't be removed. So in **all** sections (Details, Testing, etc.) and in commit messages: tickets this PR **resolves** keep the hyphen (`OPIK-1234`) — links/URLs fine and wanted. Tickets **related but not resolved** here (escalations, references to older tickets — anything not in the title/branch) must be written with an underscore (`OPIK_7000`) and with **no** Jira URL (the URL contains the hyphenated key and links anyway). Apply this when generating every section below.
The GitHub for Jira app links a PR to a ticket's Development panel whenever it finds an issue key matching `[A-Z][A-Z0-9]+-\d+` (project key, literal hyphen, digits) in the branch name, PR title, PR body, or any commit message. It matches on the regex alone — it cannot tell "this PR resolves the ticket" from "this just mentions it" — and the resulting link cannot be removed afterward. So free text must only contain hyphenated keys for tickets the PR actually resolves.
Copy file name to clipboardExpand all lines: .agents/skills/documentation/SKILL.md
+18Lines changed: 18 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,24 @@ Use the repository template at `.github/pull_request_template.md` — read the F
17
17
18
18
Also fill in the template's `## AI-WATERMARK` section (yes/no; if yes: Tools, Model(s), Scope, Human verification). Never invent a different structure such as `## Summary` / `## Test Plan`.
19
19
20
+
A section that does not apply gets `N/A` — never delete a heading.
21
+
22
+
### `## Details` — style
23
+
24
+
Write what changes for a user. A reviewer reads the diff for the code; this section tells them what is different when they use the product.
25
+
26
+
-**Short.** Most PRs need 3–10 bullets. If it runs longer, the section is doing the diff's job — cut it.
27
+
-**Bullets, not prose paragraphs.** One behavior per bullet. Nest one level for sub-cases.
28
+
-**Authoritative.** State what happens: "The run is scored once." Not "This should now mean that the run will be scored once."
29
+
-**No fluff.** No motivation paragraph, no "this PR …", no approach summary, no benefits list, no restating the diff.
30
+
-**Observable behavior first.** What the UI shows, what the API returns, what gets scored, stored or logged. Name a class, method or file only when the behavior makes no sense without it.
31
+
32
+
Pick the shape that fits the change — do not force one:
33
+
34
+
-**Before / After bullet lists** when a behavior changed and the contrast is the point.
35
+
-**A flat bullet list** for a new capability, where there is no "before".
36
+
-**One or two lines** when users cannot see the change (refactor, dependency bump) — say what is unchanged and what improved, then stop.
Copy file name to clipboardExpand all lines: .agents/skills/write-docs/SKILL.md
+18Lines changed: 18 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -263,6 +263,24 @@ Use the repository template at `.github/pull_request_template.md` — read the F
263
263
264
264
Also fill in the template's `## AI-WATERMARK` section (yes/no; if yes: Tools, Model(s), Scope, Human verification). Never invent a different structure such as `## Summary` / `## Test Plan`.
265
265
266
+
A section that does not apply gets `N/A` — never delete a heading.
267
+
268
+
### `## Details` — style
269
+
270
+
Write what changes for a user. A reviewer reads the diff for the code; this section tells them what is different when they use the product.
271
+
272
+
- **Short.** Most PRs need 3–10 bullets. If it runs longer, the section is doing the diff's job — cut it.
273
+
- **Bullets, not prose paragraphs.** One behavior per bullet. Nest one level for sub-cases.
274
+
- **Authoritative.** State what happens: "The run is scored once." Not "This should now mean that the run will be scored once."
275
+
- **No fluff.** No motivation paragraph, no "this PR …", no approach summary, no benefits list, no restating the diff.
276
+
- **Observable behavior first.** What the UI shows, what the API returns, what gets scored, stored or logged. Name a class, method or file only when the behavior makes no sense without it.
277
+
278
+
Pick the shape that fits the change — do not force one:
279
+
280
+
- **Before / After bullet lists** when a behavior changed and the contrast is the point.
281
+
- **A flat bullet list** for a new capability, where there is no "before".
282
+
- **One or two lines** when users cannot see the change (refactor, dependency bump) — say what is unchanged and what improved, then stop.
283
+
266
284
## Internationalized READMEs
267
285
268
286
`readme_CN.md`, `readme_ES.md`, `readme_FR.md`, `readme_DE.md` are AI machine-translated from the English `README.md`.
matrix+=",{\"name\":\"Integration Group $i\",\"tests\":\"${group_list[$i]}\",\"timeout\":$INTEGRATION_TIMEOUT}"
73
+
matrix+=",{\"name\":\"Integration Group $i\",\"tests\":\"${group_list[$i]}\",\"timeout\":$INTEGRATION_TIMEOUT,\"testTimeout\":\"$INTEGRATION_TEST_TIMEOUT\"}"
0 commit comments