Skip to content

Commit 4dbba55

Browse files
docs: show the full generated diff, and name the major bump
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CSm32dsxD56PkKENgav3Mn
1 parent abe194f commit 4dbba55

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

‎.claude/skills/spec-upgrade/SKILL.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,12 @@ Upstream, the spec is produced by the backend that serves these endpoints
5555
```bash
5656
git add -N -- src/unstract/api_deployments/_sdk_docstudio
5757
git diff --stat -- src/unstract/api_deployments/_sdk_docstudio
58+
git diff -- src/unstract/api_deployments/_sdk_docstudio
5859
```
5960

61+
The `--stat` is the shape of the change; the full diff is the change. Read
62+
both — the operations and fields that moved only show up in the second.
63+
6064
`git add -N` first because a plain diff cannot see a file the generator has
6165
newly created — which is precisely what a spec that grew an endpoint
6266
produces. Read the diff as the API change it represents: new modules are new
@@ -81,8 +85,10 @@ fail the same way. If it is red, run step 3 and commit the result.
8185

8286
## Versioning and release
8387

84-
Choose the bump by what changed for callers: **minor** for new endpoints or new
85-
behaviour, **patch** for fixes that keep the surface identical.
88+
Choose the bump by what changed for callers: **major** when the spec removed or
89+
renamed something callers depend on, **minor** for new endpoints or new
90+
behaviour, **patch** for fixes that keep the surface identical. A generated diff
91+
with removals in it is the signal for major — spec upgrades produce those.
8692

8793
Do not touch `__version__` in `src/unstract/api_deployments/__init__.py` in your
8894
PR. The in-repo value is the *last released* version; `main.yml` reads it,

0 commit comments

Comments
 (0)