Skip to content

Commit 52a9fdd

Browse files
annab1cursoragent
andcommitted
docs: Fix Prettier formatting in product-pulse docs
Ref: ED-24831 Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent a7b270c commit 52a9fdd

2 files changed

Lines changed: 22 additions & 8 deletions

File tree

actions/product-pulse/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ jobs:
4444
4545
## Inputs
4646
47-
| Input | Required | Default | Description |
48-
| -------------------- | -------- | -------------- | ---------------------------------------------------------------- |
49-
| `pr-number` | yes | – | Merged PR number to generate the pulse for |
50-
| `product-name` | yes | – | Product name used in the prompt and Slack header |
51-
| `model` | no | `composer-2.5` | Cursor Agent model used for generation |
52-
| `cursor-api-key` | yes | – | Cursor Agent API key |
53-
| `slack-token` | yes | – | Slack bot token with `chat:write` |
54-
| `slack-channel-id` | yes | – | Slack channel ID for pulse notifications |
47+
| Input | Required | Default | Description |
48+
| ------------------ | -------- | -------------- | ------------------------------------------------ |
49+
| `pr-number` | yes | – | Merged PR number to generate the pulse for |
50+
| `product-name` | yes | – | Product name used in the prompt and Slack header |
51+
| `model` | no | `composer-2.5` | Cursor Agent model used for generation |
52+
| `cursor-api-key` | yes | – | Cursor Agent API key |
53+
| `slack-token` | yes | – | Slack bot token with `chat:write` |
54+
| `slack-channel-id` | yes | – | Slack channel ID for pulse notifications |
5555

5656
The full generic prompt lives in this action's `prompt-template.md` and is rendered
5757
with the caller's `product-name` substituted in before being sent to Cursor Agent.

actions/product-pulse/prompt-template.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Analyze a merged PR and decide if it contains product-facing changes. If yes, ge
99
## Decision Criteria
1010

1111
### SKIP if the PR is:
12+
1213
- Pure refactoring with no user-visible changes
1314
- CI/CD pipeline changes
1415
- Dependency updates (unless it enables new features)
@@ -19,6 +20,7 @@ Analyze a merged PR and decide if it contains product-facing changes. If yes, ge
1920
- License/tier bookkeeping changes with no visible upgrade prompt or feature change
2021

2122
### INCLUDE if the PR is:
23+
2224
- New features users can interact with
2325
- Bug fixes that users would notice
2426
- UX improvements (performance, visual changes, better flows)
@@ -65,12 +67,14 @@ The `type` field must be one of: `"feature"`, `"fix"`, `"improvement"`, `"intern
6567
Follow Lovable's product update style:
6668

6769
1. **Title**: Short, benefit-focused (3-6 words)
70+
6871
- MUST clearly hint at what the feature DOES, not just what category it's in
6972
- Good: "Drag Widgets Between Columns", "Faster Editor Load Times", "Custom CSS Per Breakpoint"
7073
- Bad: "Smart Widget Management" (too vague - what does it actually DO?)
7174
- Bad: "Add nested tabs widget", "Implement collection loop transformer"
7275

7376
2. **Description**: 1-2 sentences, explain WHAT and WHY it matters
77+
7478
- Focus on user benefits, not implementation
7579
- Use simple, non-technical language
7680
- Avoid jargon like "component", "service", "endpoint", "module"
@@ -82,6 +86,7 @@ Follow Lovable's product update style:
8286
## Examples
8387

8488
### Good Example (Include):
89+
8590
```json
8691
{
8792
"skip": false,
@@ -92,6 +97,7 @@ Follow Lovable's product update style:
9297
```
9398

9499
### Bad Example (Too Technical):
100+
95101
```json
96102
{
97103
"title": "Nested Carousel Widget Renderer",
@@ -100,15 +106,18 @@ Follow Lovable's product update style:
100106
```
101107

102108
### Bad Example (Too Vague):
109+
103110
```json
104111
{
105112
"title": "Smart Widget Management",
106113
"description": "Your widgets can now be managed more efficiently in the editor."
107114
}
108115
```
116+
109117
Why it's bad: The title doesn't tell users WHAT the feature does.
110118

111119
### Good Example (Clear Action):
120+
112121
```json
113122
{
114123
"skip": false,
@@ -119,6 +128,7 @@ Why it's bad: The title doesn't tell users WHAT the feature does.
119128
```
120129

121130
### Good Example (Fix):
131+
122132
```json
123133
{
124134
"skip": false,
@@ -129,6 +139,7 @@ Why it's bad: The title doesn't tell users WHAT the feature does.
129139
```
130140

131141
### Good Example (Skip):
142+
132143
```json
133144
{
134145
"skip": true,
@@ -139,12 +150,15 @@ Why it's bad: The title doesn't tell users WHAT the feature does.
139150
## Edge Cases
140151

141152
### Chore-only PR (skip):
153+
142154
A PR titled `chore: update Playwright config` that only touches `.github/workflows/playwright.yml` and `tests/playwright/` → skip. CI and test infrastructure changes are never product-facing.
143155

144156
### Feature PR (include):
157+
145158
A PR that adds a brand-new user-visible widget or capability → include. New user-visible widgets always qualify.
146159

147160
### Partial `packages/` changes (evaluate carefully):
161+
148162
A PR that only bumps versions or updates a CHANGELOG.md under `packages/` → skip (release housekeeping).
149163
A PR that changes behavior inside a `packages/` source directory with corresponding UI impact → include. Read the diff and PR body to determine whether the package change reaches users.
150164

0 commit comments

Comments
 (0)