Skip to content

Commit e2fe23b

Browse files
authored
Merge pull request #78 from atesgoral/changelog
Add CHANGELOG.md and update rules
2 parents 3d5451a + e046b8a commit e2fe23b

File tree

2 files changed

+40
-24
lines changed

2 files changed

+40
-24
lines changed

.cursor/rules/release-changelogs.mdc

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,17 @@
11
---
2-
description: writing changelog markdown when cutting a new release of the gem
3-
globs:
2+
description: Updating CHANGELOG.md before cutting a new release of the gem
3+
globs: CHANGELOG.md
44
alwaysApply: false
55
---
6-
- output the changelog as markdown when asked.
6+
7+
- start by refreshing your knowledge on the Keep a Changelog convention by reading the format spec referenced at the top of CHANGELOG.md
8+
- stick to Keep a Changelog
9+
- entries should be terse and in a top-level flat list: do not nest
10+
- follow this format for entries:
11+
- Terse description of the change (#nnn)
712
- git tags are used to mark the commit that cut a new release of the gem
813
- the gem version is located in [version.rb](mdc:lib/mcp/version.rb)
914
- use the git history, especially merge commits from PRs to construct the changelog
10-
- when necessary, look at the diff of files changed to determine whether a PR should be listed in
11-
- ## Added; adds new functionality
12-
- ## Changed; alters functionality; especially backward compatible changes
13-
- ## Fixed; bugfixes that are forward compatible
14-
15-
use the following format for changelogs:
16-
17-
```
18-
## Added
19-
- New functionality added that was not present before
20-
21-
## Changed
22-
- Alterations to functionality that may indicate breaking changes
23-
24-
## Fixed
25-
- Bug fixes
26-
27-
#### Full change list:
28-
- [Name of the PR #123](https:/github.com/modelcontextprotocol/ruby-sdk/pull/123) @github-author-username
29-
- [Name of the PR #456](https:/github.com/modelcontextprotocol/ruby-sdk/pull/456) @another-github-author
30-
```
15+
- when necessary, look at the diff of files changed to determine the true nature of the change
16+
- maintenance PRs that don't concern end users of the gem should not be listed in the changelog
17+
- when checking PRs, see if there's an upstream remote, and if so, fetch PRs from upstream instead of origin

CHANGELOG.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
12+
- Custom methods support via `define_custom_method` (#75)
13+
- Streamable HTTP transport implementation (#33)
14+
- Tool argument validation against schemas (#43)
15+
16+
### Changed
17+
18+
- Server context is now optional for Tools and Prompts (#54)
19+
- Improved capability handling and removed automatic capability determination (#61, #63)
20+
- Refactored architecture in preparation for client support (#27)
21+
22+
### Fixed
23+
24+
- Input schema validation for schemas without required fields (#73)
25+
- Error handling when sending notifications (#70)
26+
27+
## [0.1.0] - 2025-05-30
28+
29+
Initial release

0 commit comments

Comments
 (0)