-
Notifications
You must be signed in to change notification settings - Fork 110
Expand file tree
/
Copy pathrelease-changelogs.mdc
More file actions
30 lines (25 loc) · 1.07 KB
/
release-changelogs.mdc
File metadata and controls
30 lines (25 loc) · 1.07 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
---
description: writing changelog markdown when cutting a new release of the gem
globs:
alwaysApply: false
---
- output the changelog as markdown when asked.
- git tags are used to mark the commit that cut a new release of the gem
- the gem version is located in [version.rb](mdc:lib/mcp/version.rb)
- use the git history, especially merge commits from PRs to construct the changelog
- when necessary, look at the diff of files changed to determine whether a PR should be listed in
- ## Added; adds new functionality
- ## Changed; alters functionality; especially backward compatible changes
- ## Fixed; bugfixes that are forward compatible
use the following format for changelogs:
```
## Added
- New functionality added that was not present before
## Changed
- Alterations to functionality that may indicate breaking changes
## Fixed
- Bug fixes
#### Full change list:
- [Name of the PR #123](https:/github.com/modelcontextprotocol/ruby-sdk/pull/123) @github-author-username
- [Name of the PR #456](https:/github.com/modelcontextprotocol/ruby-sdk/pull/456) @another-github-author
```