Skip to content

Commit 765cf5e

Browse files
committed
CHANGELOG clarity, instructions
1 parent 97efac2 commit 765cf5e

2 files changed

Lines changed: 11 additions & 2 deletions

File tree

.github/copilot-instructions.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,19 @@ building durable orchestrations. The repo contains two packages:
1515
- Update `CHANGELOG.md` for core SDK changes and
1616
`durabletask-azuremanaged/CHANGELOG.md` for provider changes.
1717
- If a change affects both packages, update both changelogs.
18+
- Include changelog entries for externally observable outcomes only, such as
19+
new public APIs, behavior changes, bug fixes users can notice, breaking
20+
changes, and new configuration capabilities.
1821
- Do NOT document internal-only changes in changelogs, including CI/workflow
1922
updates, test-only changes, refactors with no user-visible behavior change,
2023
and implementation details that do not affect public behavior or API.
24+
- When in doubt, write the changelog entry in terms of user impact (what users
25+
can now do or what behavior changed), not implementation mechanism (how it
26+
was implemented internally).
27+
28+
Examples:
29+
- Include: "Added `get_orchestration_history()` to retrieve orchestration history from the client."
30+
- Exclude: "Added internal helper functions to aggregate streamed history chunks."
2131

2232
## Language and Style
2333

CHANGELOG.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
ADDED
1111

1212
- Added `get_orchestration_history()` and `list_instance_ids()` to the sync and async gRPC clients.
13-
- Added in-memory backend support for `StreamInstanceHistory` and `ListInstanceIds` to enable history retrieval and completion-window pagination in tests.
14-
- Added internal history helpers for aggregating streamed history events, de-externalizing payload-backed values, and converting history events to dictionaries.
13+
- Added in-memory backend support for `StreamInstanceHistory` and `ListInstanceIds` so local orchestration tests can retrieve history and page terminal instance IDs by completion window.
1514

1615
## v1.4.0
1716

0 commit comments

Comments
 (0)