Skip to content

Commit cb77e1e

Browse files
committed
next attempt
1 parent 91417b2 commit cb77e1e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

changelog_prompt.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ The audience for the release notes consists of experienced developers who integr
88

99
SOURCE CONTENT IS A CHANGELOG:
1010

11-
You’ll be provided with a changelog that is automatially generated from the update. The problem with the generated changelog is that it's very verbose and includes a lot of extraneous and duplicated information. Your task is to analyze the diff and clearly describe the changes. Group similar changes together and make the descriptions compact and meaningful. I’ll pull from your descriptions to populate the release notes.
11+
You’ll be provided with a changelog that is automatially generated from the update. The problem with the generated changelog is that it's very verbose and includes a lot of extraneous and duplicated information. Your task is to analyze the changelog and clearly describe the changes. Group similar changes together and make the descriptions compact and meaningful. I’ll pull from your descriptions to populate the release notes.
1212

1313
IGNORE GRAMMAR/STYLE CHANGES
1414

15-
The diff is comprehensive and includes many grammar and style changes to existing definitions. Ignore these, as they’re minor cosmetic updates for readability that don’t need to be included in the release notes.
15+
The changelog is comprehensive and includes many grammar and style changes to existing definitions. Ignore these, as they’re minor cosmetic updates for readability that don’t need to be included in the release notes.
1616

1717
INTERPRETING THE GENERATED CHANGELOG:
1818

19-
The changelog lists each endpoint that has changed and a nested list underneath that indicates the context for the change. There can be common changes that affect multiple endpoints.
19+
The changelog lists each endpoint that has changed and a nested list underneath that indicates the context for the change. There can be common changes that affect multiple endpoints. The changes under each endpoint are represented as a tree, with the most important information being found in the leafs of the tree. Some endpoints have only a single leaf, and others have multiple.
2020

2121
YOUR TASK:
2222

23-
Analyze the diff and describe the changes that have been made using plain, readable language. Your analysis will mostly be matter of fact, describing the changes. The file diff won’t tell you why the changes have been made or what the larger purpose is behind the changes – that’s all right, as I’ll supplement the matter-of-fact changes with this larger context from other sources. Your task is mainly to describe the differences in the file diff. Especially not the following:
23+
Analyze the changelog and describe the changes that have been made using plain, readable language. Your analysis will mostly be matter of fact, describing the changes. Ensure that every endpoint and change (the leafs) is included in the summary; don't leave any of these critical items out. The changelog won’t tell you why the changes have been made or what the larger purpose is behind the changes – that’s all right, as I’ll supplement the matter-of-fact changes with this larger context from other sources. Your task is mainly to describe the differences in the changelog. Especially the following:
2424

2525
New features: Describe any added classes, methods, or capabilities. Extrapolate the descriptions and purposes for the elements from the code.
2626
Deprecations: Identify any deprecated classes, methods, or fields.

0 commit comments

Comments
 (0)