Skip to content

Commit c3f905d

Browse files
committed
better changeset for agents
1 parent c5eb149 commit c3f905d

1 file changed

Lines changed: 20 additions & 4 deletions

File tree

AGENTS.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,25 @@ pnpm changeset status
115115
```
116116

117117
Changeset guidelines:
118-
- Create a changeset for any user-facing changes (features, bug fixes); typically in new pull requests; a pull request can have multiple changesets
118+
- Create a changeset for any user-facing changes (features, bug fixes); typically in new pull requests;
119+
- a pull request can have multiple changesets
119120
- Select the appropriate semver bump: `patch` (bug fixes) or `minor` (new features)
120121
- This is a pre-1.0 preview release, so there are no `major` breaking change bumps
121-
- Write a clear, concise description of the change for the changelog
122-
- The three main packages (`@salesforce/b2c-cli`, `@salesforce/b2c-tooling-sdk`, `@salesforce/b2c-dx-mcp`) are version-linked
123-
- Internal-only changes (tests, docs, refactoring) typically don't need changesets
122+
- Good changesets explain:
123+
- WHAT the change is
124+
- WHY the change was made
125+
- HOW a consumer should update their code
126+
127+
For headless/agentic use, create a changeset file directly in `.changeset/` with a unique filename (e.g., `descriptive-change-name.md`):
128+
129+
```md
130+
---
131+
'@salesforce/b2c-cli': patch
132+
'@salesforce/b2c-tooling-sdk': patch
133+
---
134+
135+
Description of the change explaining WHAT, WHY, and HOW to update
136+
```
137+
138+
- Include only the packages that were modified
139+
- Use `patch` for bug fixes, `minor` for new features

0 commit comments

Comments
 (0)