Skip to content

Commit eab65cd

Browse files
authored
Add the first skill write-changelog item (#1528)
1 parent c9c602c commit eab65cd

2 files changed

Lines changed: 31 additions & 0 deletions

File tree

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Write Changelog Item
2+
3+
Using the @infra/skills/write_changelog_item/SKILL.md write the item and put it
4+
under the @documentation/pages/release-notes.mdx under the right block (make
5+
sure the items in the block are orderd by the PR number, existing PRs are
6+
already ordered):
7+
8+
@PR 3730: memgraph/memgraph
9+
10+
... after this just keep pasting only the PR links below ...
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: write_changelog_item
3+
description: Create/write the changelog item / release note for a given Github PR
4+
---
5+
6+
For a given Github PR write a changelog item.
7+
8+
The changelog item should be benefit focused (highlight the why). The changelog
9+
item should be in the markdown format, don't remove ticks and markdown links,
10+
don't use bold and italic, use - at the beginning of the item.
11+
12+
Usually the PR has the item written in our of the commends under the PR. Try to
13+
extract that first and improve according to the above description.
14+
15+
If that changelog item is not already there, feel free to create one, again
16+
according the the above guidelines.
17+
18+
If the PR introduces the breaking change, wrote 2 items one for the "regular"
19+
sections (Features, Improvements, Bug Fixes, Bug) and one for the Breaking
20+
section. The item under the Breaking section should be in the format: "What
21+
happend? What the end-user should do about it?".

0 commit comments

Comments
 (0)